This is the call that occurs when a customer is in store engaging with a cashier, and provides information that can be used to identify this customer. The identification of the customer is crucial for the next step in the workflow, and is made accessible to that request via the hash value that is returned in the response of this request.
\ncard_number (string): part of the user's identification which allows us to access details about account holder, can be given as:
card number
\nemail address
\nmobile phone number
\napp token
\ncedula
\npassport number
\npos_session: an object that holds information about the current point of sale session that has been created with this request, this object contains:
id: an internal reference number for this current session
hash: the hash value associated with this current order session
date_created: holds the time this session was created as a Unix timestamp in seconds from 1970-01-01 00:00:00
date_updated: holds the last time this session was updated as a Unix timestamp in seconds from 1970-01-01 00:00:00
status (see Appendix): an object that holds information about the current status of the order
vendor: an object that contains information about the vendor this order has been created through
id: an internal reference number for this vendor
point_of_sale: an object that holds information about this current point of sale
id: an internal reference number which indicates the type of point of sale
name: indicates the type of point of sale in a way that is more user friendly
status (see Appendix): an object that holds information about the current status of the point of sale
modules: an object which contains information about the modules used for this order
data: an array of objects where each object holds information about a module used, each object contains:
id: an internal reference number indicating the current module in use
name: indicates the current module in use in a way that is more user friendly
api_key: used for a small subset of point of sale integration, can likely be ignored
workstation_identifer: string identifier for the key used in point of sale integration, can likely be ignored{\n \"id\": 1,\n \"name\": \"Active\"\n }\n\nid: an internal reference number indicating the status
name: indicates the current status in a way that is more user friendly
This request uses the point of sale session hash key that was generated with the onscreen_create request to access the identification information that was provided by the user. This identification information allows us to retrieve the user's account, which gives us information like their first and last names, their birthday, and a list of rewards this user is currently eligible for. The user's loyalty and quick pay balances are also retrieved at this point, which are necessary in the step for the authorization of payments.
\npos_session_hash (string): passed in using query parameters, must match the hash found in the response of the onscreen_create requestpos_session: an object that holds information regarding this specific point of sale session, this object contains:
pos_session_id: the internal reference number that is related to the current point of sale session hash: the hash value associated with this current order session status (see Appendix): an object that holds information about the current status of the orderOnly one of the following three arguments will have a value that is not null at any given time. The argument that gets a non-null value depends on how the user checked in.
\ncard: if the user checked in with a card, that information is held here and the other two arguments are nullcard_third_party: if the user checked in with a third party card, that information is held here and the other two arguments are nulltoken: if the user used any other method to check in, that information is held here and the other two arguments are nulluser: an object that holds all information related to the user in the current session
email_address: the user's email addressdefault_billing_profile: an identification number associated with the user's default billing profilebirthdate: the user's date of birth, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00address: the user's addressphone_number: the user's phone numbercedula: the user's cedula, if applicableclover_id: the user's clover idpassport_number: the user's passport numberfirst_name: the user's first namelast_name: the user's last nameis_employee: true if the user is an employee with this vendor, false if the user is notid: the internal reference number for the userbirthday: the user's birthdaylast_visit: the date the user last visited this vendor, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00favourite_items: an array that contains information about the user's favourite items
reload: an object that contains information regarding the user's auto-reload configuration
amount: how much a user has indicated to reload automatically with automatic reloadthreshold: the point at which the user's account will automatically reloadbilling_profile: the user's billing profile that is selected for automatic reloadfavorite: deprecated
last_visit: deprecated
loyalty_balance: an object that contains information about the loyalty balance associated with this user, this object contains
data: an array of objects where each contains a different piece of information about a user's loyalty balanceamount: the number of units of a certain currency that is associated with the user's accountcurrency (see Appendix): an object that contains information about the type of currency being usedexpiring (see Appendix): an object that holds information about when this balance will expirerules: an object that holds information about the rules for this current point of sale, each object contains:
earning: an object which contains information about the rules related to earning loyalty points, this object contains:data: an array that holds all necessary information for the loyalty point earning process, each object contains earning information for one perkid: an internal reference number for this earning rulecurrency (see Appendix): an object that contains information about the type of currency being usedname: indicates the type of current in a way that is more user friendlyperk_type: an object that holds information about the type of perk offered that is earning pointsid: an internal reference number that is unique to each type of perkname: indicates the type of perk in a way that is more user friendlyround_policy: an object that holds information about how points will be rounded during this point of saleid: an internal reference number that indicates the type of rounding that is to occurname: indicates the type of rounding in a way that is more user friendlyaward_amount: the ratio of points awarded when the earning rule is invokedmax_award_amount: the maximum number of points that can be earned in a single instance of a point of salestart_date: the date this perk begins, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00end_date: the date this perk ends, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that contains information about the current status of the earning rulespending: an object that holds information about the rules related to spending loyalty points, each object contains:data: an array that contains all information necessary to the loyalty point spending process, each object in the array contains spending information for one reward:template (see Appendix): the style type for how the perk should be displayedid: the internal reference number unique to each rewardcurrency (see Appendix): an object that contains information about the type of currency being usedname: indicates the type of reward in a way that is more user friendlydescription: a description of what the reward entailssummary: a brief overview of what the promotion is and what points will be removedcost: how many points this promotion costs to redeemstart_date: the date this promotion begins, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00end_date: the date this promotion ends, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00available: how many perks of this type the user is able to redeem with their current loyalty balanceprogress: the number of points the user has towards qualifying for a perk of this typecatalog: an object that holds information regarding the item that is attached to this redemptionid: an internal reference number that is unique to each itemidentifier: the reference number for this item that is supplied by the point of salename: indicates the item in a way that is more user friendlytype: in spending rules, perks are exclusively type discountid: an internal reference number that is unique to type discountname: indicates the type of the current spending rule in a way that is more user friendlytier: an object that holds information about the prestige level of the usercount: total number of tiers this vendor hascurrent: an object that holds information about the current tiername: indicates the current tier in a way that is more user friendlysince: the date this tier was achieved, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00type: an object that contains the specific information for this tierid: an internal reference number unique to each type of tiername: indicates the type of this tier in a way that is more user friendlyranking: the rank of this tiernext: an object that contains information about the next tier level to be attainedname: indicates the name of the next tier in a way that is more user friendlyamount: the number of criteria required to achieve this tierprogress: the number of criteria the user currently has towards reaching the next tiersummary: a summary of the perks offered at the next tierdescription: a description of the next tierall: an object that contains information about all tiers possible at this vendorvendor_tier_changed: the last date the user's tier changed, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00tier_immunity_days: a configuration value from the vendor, indicates how long a user has on this tier before being downgradeddays_remaining: the time left between now and when the user will be downgradeddata: an array of objects that each hold information about one tier, one object for each tier holds the same information found in nextquick_pay_balance: an object that holds information about the quick pay balance a user has linked to their account
amount: the total units of currency availablecurrency (see Appendix): an object that contains information about the type of currency being usedexpiring (see Appendix): an object that holds information about when this balance will expire{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly{\n \"id\": 191,\n \"name\": \"Canadian Dollar\",\n \"code\": \"CAD\"\n }\nid: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendlycode: the ISO 4217 code associated with this type of currency, a null value here indicates a loyalty currency{\n \"data\": []\n }\ndata: an array of objects that give information about the date of expiry of this loyalty balance (as a Unix timestamp in seconds from 1970-01-01 00:00:00), and the quantity of the balance that expires on this date{\n \"id\": 2,\n \"name\": \"POINT\"\n }\nid: an internal reference number that is unique to each templatename: indicates the template style in a way that is more user friendlyThis request is not necessary to the workflow as it only gives information about the vendor and their perks, but can be loosely included in the \"checking in\" step. All the active perks at this vendor are listed, regardless of if the user qualifies or not.
\nThe only information required for this request is the api_key given in the query parameters.
The response appears as an array of objects where each object contains information about an individual perk. Each object contains:
\nvendor_perk_redemption_id: an internal reference number that is unique to each perkvendor: an object that holds information about the current vendor, this object contains:vendor_id: an internal reference number that is unique to each vendorname: indicates the current vendor in a way that is more user friendlystatus (see Appendix): an object that holds information about the current status of this vendortype: an object that contains information about the type of perk that is being offered, this object contains:perkRedemptionType_id: an internal reference number that is unique to each type of perkname: indicates the type of perk in a way that is more user friendlycurrency (see Appendix): an object that contains information about the type of currency being usedtemplate (see Appendix): the style type for how the perk should be displayedname: indicates the name of the perk in a way that is more user friendlysummary: a brief overview of what the perk is and what points will be removeddescription: a description of what the perk entailscost: how many points this perk costs to redeemstart_date: the date this perk begins, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00end_date: the date this perk ends, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00date_created: the date this perk was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00date_updated: the last date this perk was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that holds information about the current status of this list{\n \"status_id\": 1,\n \"name\": \"Active\"\n }\nstatus_id: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly{\n \"id\": 191,\n \"name\": \"Canadian Dollar\"\n }\nid: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendly{\n \"id\": 2,\n \"name\": \"POINT\"\n }\nid: an internal reference number that is unique to each templatename: indicates the template style in a way that is more user friendlyThis request is used if the user authorizes payment for the current order with their quick pay balance. The quick pay balance is retrieved by using a specific means of identification, and is used here to determine if the user has sufficient funds to spend the desired amount in quick pay, or if the user has sufficient funds to load their quick pay balance.
\ncard_number (string): part of the user's identification which allows us to access details about the account holder, can be given as:till (integer): only used for tracking and information purposes, and is not relevant to the order itselfamount (float): indicates how much is being added to or removed from the user's account, a positive value here adds this amount and a negative value removes this amountdate (integer): the date this authorization is occurring, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00 in the customer's local timecashier (object, see Appendix below): used for tracking and information purposes, not relevant to the order itselfsuccess: indicates if the request was successfully authorized by Spoonity or notreference_number: the identification number that Spoonity uses to keep track of this order internallyreceipt_data: holds information about the process that just occurred and information about the user indicated in the request. Contains:lines: shows the process was successful in a way that is user friendlyuser: contains more in depth information about the user making the order:id: an internal reference number that is unique to each usercard_number: the same card_number that was provided in the requestbalances: an array that contains information about the different balances a user has on their profile. Each object in balances contains:id: an identification number for the type of currencycurrency: indicates the type of currency in a way that is more user friendlybalance: the amount of this currency that is availabletype: indicates the category of payment being used{\n \"id\": \"1\",\n \"name\": \"Tony\"\n }\n\nid (string): an identification number assigned to a cashiername (string): the name of the cashierThis request is used if the user authorizes payment for the current order with their loyalty balance. The loyalty balance is retrieved by using a specific means of identification, and is used here to determine if the user has sufficient funds to use the desired amount in loyalty points.
\ncard_number (string): part of the user's identification which allows us to access details about the account holder, can be given as:amount (float): the amount that is being paid in dollars by the usersuccess: indicates if the request was successfully authorized by Spoonity or notamount: indicates the amount in dollars that was removed from the user's account, amount of points actually removed varies based on individual loyalty systemstransaction_id: a reference number that only supplements the order, this number only references the payment itselfHere, details about the items in the order, discounts on these items, and discounts on the overall order are sent to our system to complete the sale. If the user is spending points on this order, this request removes them from the user's account. If there are any points to be gained on this order, this request will also add those points to the user's account. The appearance of the response of this request may change based on the structure of the loyalty system with each vendor. Once this order is complete, often the DEL onscreen_close request is called immediately to close the session.
\n\n\nNote: to see examples for both spending points and earning points, toggle between the two options at the top of the example request.
\n
card_number (string): part of the user's identification which allows us to access details about the account holder, can be given as:
card number
\nemail address
\nmobile phone number
\napp token
\ncedula
\npassport number
\ntill (integer): only used for tracking and information purposes, and is not relevant to the order itself
receipt_number (string): the invoice id from the point of sale
subtotal (float): the only value that is used to calculate points earned from this order
taxes (array): holds information about what taxes are on the order, not relevant to the calculation of points
total (float): the amount the customer actually pays, not relevant to the calculation of points
payment_method (string): how the customer pays for the order
date (integer): the date this authorization is occurring, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00 in the customer's local time
cashier (object, see Appendix below): used for tracking and information purposes, not relevant to the order itself
line_items (array of line_item objects, see Appendix below): holds information about each item in the order
discount (array of discount objects, see Appendix): holds objects that have information about discounts on the overall order
reference_number: the identification number that Spoonity uses to keep track of this order internally
success: indicates if the request was successfully authorized by Spoonity or not
receipt_data: holds information about the process that just occurred and information about the user indicated in the request, contains:
lines: shows the process was successful in a way that is user friendly
points: contains information about the points that are being redeemed or earned, each object in this array contains
currency (see Appendix): an object that holds information about the type of currency being used
amount: indicates the quantity of the points that are being removed or added
expiryDate: indicates the date that these points will expire, as a Unix timestamp in seconds from 1970-01-01 00:00:00
user: contains more in depth information about the user making the order:
id: an internal reference number that is unique to each user
card_number: the same card_number that was provided in the request
balances: an array that contains information about the different balances a user has on their profile
id: an internal reference number for the type of currency
currency: indicates the type of currency in a way that is more user friendly
balance: the amount of this currency that is available
type: indicates the category of payment being used
{\n \"id\": \"1\",\n \"name\": \"Tony\"\n }\n\nid (string): an identification number assigned to a cashier
name (string): the name of the cashier
{\n \"id\": \"coffee\",\n \"name\": \"Regular Drip\",\n \"categories\": [],\n \"discounts\": [],\n \"price\": 2,\n \"quantity\": 1,\n \"modifiers\": []\n }\n\nid (string): an identification number that is unique to this item
name (string): identifies the item in a way that is more user friendly
categories (array): not relevant to the order, can be ignored
discounts (array of discount objects, see Appendix): holds objects that have information about a discount specific to this line item
price (float): indicates the price of 1 unit of this item, must be a positive value
quantity (integer): indicates how many units of this item are being purchased on this order
modifiers (array of line_items, see Appendix): contains information about items which modify the current item being ordered
{\n \"id\": \"clover_discount\",\n \"name\": \"Free item\",\n \"amount\": 2\n }\n\nid (string): an internal reference that is unique to this item
name (string): identifies the item in a way that is more user friendly
amount (float): indicates how much this discount is worth in dollars, must be a positive value
{\n \"id\": \"coffee\",\n \"name\": \"Regular Drip\",\n \"categories\": [],\n \"discounts\": [],\n \"price\": 2,\n \"quantity\": 1,\n \"modifiers\": []\n }\n\nid (string): an identification number that is unique to this item
name (string): identifies the item in a way that is more user friendly
categories (array): not relevant to the order, can be ignored
discounts (array of discount objects, see Appendix): holds objects that have information about a unique discount
price (float): indicates the price of 1 unit of this item
quantity (integer): indicates how many units of this item are being purchased on this order
modifiers: each modifier has another array of modifiers, making it possible for modifiers to be nested infinitely
{\n \"id\": 191,\n \"name\": \"Canadian Dollar\"\n }\n\nid: an identification number for the type of currency
name: indicates the type of currency in a way that is more user friendly
This request uses the session hash key that was generated in the first call of this workflow to close the current session so the next user can check in. In most cases, the Spoonity API automatically closes the most recent session once an order is complete, however this request can also be called manually.
\npos_session_hash: the hash value for the session that is being closedThe response will always be empty, however a status of \"200 OK\" indicates successful closure.
\n","urlObject":{"path":["onscreen"],"host":["{{endpoint}}"],"query":[{"key":"api_key","value":"{{apikey}}"}],"variable":[]}},"response":[{"id":"8c6746d9-3946-4136-97fa-fe0d14bdc76c","name":"onscreen_close","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"pos_session_hash\": \"9c18e2d6bc8e9771a96b248061f2a5ff\"\n\n}"},"url":{"raw":"{{endpoint}}/onscreen?api_key={{apikey}}","host":["{{endpoint}}"],"path":["onscreen"],"query":[{"key":"api_key","value":"{{apikey}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 May 2019 15:39:22 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.1.15 OpenSSL/1.0.2k-fips"},{"key":"X-Powered-By","value":"PHP/7.1.15"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"97d75bcd-9840-4d9f-858a-563a208e24b3"},{"name":"order_void","id":"0e53a88c-4b73-4a6e-ad8e-98387b92de92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"receipt\": 17074472\n}"},"url":"{{endpoint}}/order/void?api_key={{apikey}}","description":"This request is used to void an order if necessary. Orders can only be voided in order from the most recent sale. To void a sale that was not the most recent, the more recent orders must be voided until the desired order to void is reached, that order must be voided, then the more recent orders must be re-applied in the sequence they occurred.
\nreceipt (integer): identifies which order is meant to be voided, matches the reference_number that is found in the response of the order_process (loyalty) requestvoided: true if this order was successfully voidedThe customer physically walks into the vendor, interacts with a cashier, and provides information that we can use to identify this customer. We run a search against our API with this information and determine the customer's account information.
\n - POST /onscreen\n - GET /onscreen\n - GET /vendor/perk/redemption/list\n\nIn this step, the account information given by the customer is used to determine if they have sufficient funds for the payment they are trying to authorize. After reviewing their balances, if it is determined that the customer has the funds, their account can be credited or debited according to the type of transaction they are authorizing.
\n - POST /order\n - POST /order/payments/loyalty\n\nHere, information relating to the items in this order, discounts on these items, and any discounts on the overall order are sent to our system to complete the sale.
\n - POST /order\n\nThe session must be closed in order to allow the next customer to check in. In most cases, this step occurs automatically once the order process is complete, but can also be called manually.
\n - DEL /onscreen\n\nThis request will cancel a transaction using the reference number from that order. It is important to note that this can only occur in order from the most recent sale. To void a sale that was not the most recent, more recent orders must be voided until the desired order is reached, that order voided, then the more recent orders must be re-applied in the sequence they occurred.
\n - POST /order/void\n\nThis request is used to access a list of users who are already checked in, which can be done by the customer through a mobile application or manually by a cashier. The request returns an array of sessions of checked in users, each with a unique point of sale hash key which is referenced whenever that session's user information is required.
\nThe only information required for this request is the api_key given in the query parameters.
Each object in the array has information for:
\npos_session: an object that holds information regarding this specific point of sale session, this object contains: id: the internal reference number that is related to the current point of sale session hash: the hash value associated with this current order sessionvendor: an object that contains information about the current vendor, this object includes:vendor_id: an internal reference number unique to each vendorname: indicates the vendor in a way that is more user friendlyuser: an object that holds information about the user checking into this session, this object contains:user_id: an internal reference number unique to each userfirst_name: the user's first namelast_name: the user's last nameemail_address: the user's email addresstable_number: the table number the user has checked in toredemptions (see Appendix): an array of all redemptions a user desires to use this session, which was specified through the mobile applicationpayments (see Appendix): an array of all payment options a user desires to use this session, which was specified through the mobile applicationdate_created: the date this session was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00date_updated: the last date this session was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that contains information about the current status of the point of sale session{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly\"redemptions\": [{\n \"vendor_perk_redemption_id\": 121,\n \"name\": \"Free Coffee\",\n \"currency\": {\n \"currency_id\": 45,\n \"name\": \"Coffee Point\"\n },\n \"cost\": 10\n }]\nvendor_perk_redemption_id: internal reference number that is unique to each vendor perk redemptionname: indicates the vendor perk redemption in a way that is more user friendlycurrency (see Appendix): an object that contains information about the type of currency being usedcost: indicates the price of 1 unit of this redemption\"payments\": [{\n \"method\": \"quickpay\",\n \"amount\": 20.00\n }]\nmethod: the payment method the customer has specified to use, can be:\n\nNote: if the method provided is billing_profile, another parameter is necessary:\n
\nuser_billingProfile_id: the internal reference number associated with the user's billing profile
amount: the amount that is being authorized to be paid out of this account{\n \"currency_id\": 45,\n \"name\": \"Coffee Point\"\n },\ncurrency_id: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendlyThis request uses the point of sale session hash key to access the identification information that was provided by the user. This identification information allows us to retrieve the user's account, which gives us information like their first and last names, their birthday, and a list of rewards this user is currently eligible for. The user's loyalty and quick pay balances are also retrieved at this point, which are necessary in the step for the authorization of payments.
\npos_session_hash (string): passed in using query parameters, must match the hash found in the response of the onscreen_create requestpos_session: an object that holds information regarding this specific point of sale session, this object contains:
pos_session_id: the internal reference number that is related to the current point of sale session hash: the hash value associated with this current order session status (see Appendix): an object that holds information about the current status of the point of sale sessionOnly one of the following three arguments will have a value that is not null at any given time. The argument that gets a non-null value depends on how the user checked in.
\ncard: if the user checked in with a card, that information is held here and the other two arguments are nullcard_third_party: if the user checked in with a third party card, that information is held here and the other two arguments are nulltoken: if the used any other method to check in, that information is held here and the other two arguments are nulluser: an object that holds all information related to the user in the current session
email_address: the user's email addressdefault_billing_profile: an identification number associated with the user's default billing profilebirthdate: the user's date of birth as a Unix timestamp in seconds from 1970-01-01 00:00:00address: the user's addressphone_number: the user's phone numbercedula: the user's cedula, if applicableclover_id: the user's clover idpassport_number: the user's passport numberfirst_name: the user's first namelast_name: the user's last nameis_employee: true if the user is an employee with this vendor, false if the user is notid: the internal reference number for the userbirthday: the user's birthdaylast_visit: the date the user last visited this vendor, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00favourite_items: an array that contains information about the user's favourite items
reload: an object that contains the information regarding the user's auto-reload configuration
amount: how much a user has indicated to reload automatically with automatic reloadthreshold: the point at which the user's account will automatically reloadbilling_profile: the user's billing profile that is selected for automatic reloadfavorite: deprecated
last_visit: deprecated
loyalty_balance: an object that contains information about the loyalty balance associated with this user, this object contains
data: an array of objects where each contains a different piece of information about the user's loyalty balanceamount: the number of units of a certain currency that is associated with the user's accountcurrency (see Appendix): an object that contains information about the type of currency being usedexpiring (see Appendix): an object that holds information about when this balance will expirerules: an object that holds information about the rules for this current point of sale, each object contains:
earning: an object which contains information about the rules related to earning loyalty points, this object contains:data: an array that holds all necessary information for the loyalty point earning process, each object contains earning information for one perkid: an internal reference number for this earning rulecurrency (see Appendix): an object that contains information about the type of currency being usedname: indicate the type of currency in a way that is more user friendlyperk_type: an object that holds information about the type of perk offered that is earning pointsid: an internal reference number that is unique to each type of perkname: indicates the type of perk in a way that is more user friendlyround_policy: an object that holds information about how points will be rounded during this point of saleid: an internal reference number that indicates the type of rounding that is to occurname: indicates the type of rounding in a way that is more user friendlyaward_amount: the ratio of points awarded when the earning rule is invokedmax_award_amount: the maximum number of points that can be earned in a single instance of a point of salestart_date: the date this perk begins, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00end_date: the date this perk ends, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that contains information about the current status of the earning rulespending: an object that holds information about the rules related to spending loyalty points, each object contains:data: an array that contains all information necessary to the loyalty point spending process, each object in the array contains spending information for one reward:template (see Appendix): the style type for how the perk should be displayedid: the internal reference number unique to each rewardcurrency (see Appendix): an object that contains information about the type of currency being usedname: indicates the type of reward in a way that is more user friendlydescription: a description of what the reward entailssummary: a brief overview of what the promotion is and what points will be removedcost: how many points this promotion costs to redeemstart_date: the date this promotion begins, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00end_date: the date this promotion ends, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00available: how many perks of this type the user is able to redeem with their current loyalty balanceprogress: the number of points the user has towards qualifying for a perk of this typecatalog: an object that holds information regarding the item that is attached to this redemptionid: an internal reference number that is unique to each itemidentifier: the reference number for this item that is supplied by the point of salename: indicates the item in a way that is more user friendlytype: in spending rules, perks are exclusively type discountid: an internal reference number that is unique to type discountname: indicates the type of the current spending rule in a way that is more user friendlytier: an object that holds information about the prestige level of the usercount: total number of tiers this vendor hascurrent: an object that holds information about the current tiername: indicates the current tier in a way that is more user friendlysince: the date this tier was achieved, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00type: an object that contains the specific information for this tierid: an internal reference number unique to each tiername: indicates the type of this tier in a way that is more user friendlyranking: the rank of this tiernext: an object that contains information about the next tier level to be attainedname: indicates the name of the next tier in a way that is more user friendlyamount: the number of criteria required to achieve this tierprogress: the number of criteria the user currently has towards reaching the next tiersummary: a summary of the perks offered at the next tierdescription: a description of the next tierall: an object that contains information about all tiers possible at this vendorvendor_tier_changed: the last date the user's tier changed, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00 tier_immunity_days: a configuration value from the vendor, indicates how long a user has on this tier before being downgradeddays_remaining: the time left between now and when the user will be downgradeddata: an array of objects that each hold information about one tier, one object for each tier holds the same information found in currentquick_pay_balance: an object that holds information about the quick pay balance a user has linked to their account
amount: the total units of currency availablecurrency (see Appendix): an object that contains information about the type of currency being usedexpiring (see Appendix): an object that holds information about when this balance will expire{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly{\n \"id\": 191,\n \"name\": \"Canadian Dollar\",\n \"code\": \"CAD\"\n }\nid: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendlycode: the ISO 4217 code associated with this type of currency, a null value here indicates a loyalty currency{\n \"data\": []\n }\ndata: an array of objects that give information about the date of expiry of this loyalty balance (as a Unix timestamp in seconds from 1970-01-01 00:00:00), and the quantity of the balance that expires on this date){\n \"id\": 2,\n \"name\": \"POINT\"\n }\nid: an internal reference number that is unique to each templatename: indicates the template style in a way that is more user friendlyThis request is used if the user authorizes payment for the current order with their quick pay balance. The quick pay balance is retrieved by using a specific means of identification, and is used here to determine if the user has sufficient funds to spend the desired amount in quick pay, or if the user has sufficient funds to load their quick pay balance.
\ncard_number (string): part of the user's identification which allows us to access details about the account holder, can be given as:till (integer): only used for tracking and information purposes, and is not relevant to the order itselfamount (float): indicates how much is being added to or removed from the user's account, a positive value here adds this amount and a negative value removes this amountdate (integer): the date this request is being made, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00cashier (object, see Appendix below): used for tracking and information purposes, not relevant to the order itselfsuccess: indicates if the request was successfully authorized by Spoonity or notreference_number: the identification number that Spoonity uses to keep track of this order internallyreceipt_data: holds information about the process that just occurred and information about the user indicated in the requestlines: shows the process was successful in a way that is user friendlyuser: contains more in depth information about the user making the order:id: an internal reference number that is unique to each usercard_number: the same card_number that was provided in the requestbalances: an array that contains information about the different balances a user has on their profile. Each object in balances contains:id: an identification number for the type of currencycurrency: indicates the type of currency in a way that is more user friendlybalance: the amount of this currency that is availabletype: indicates the category of payment being used{\n \"id\": \"1\",\n \"name\": \"Tony\"\n }\nid (string): an identification number assigned to a cashiername (string): the name of the cashierThis request is used if the user authorizes payment for the current order with their loyalty balance. The loyalty balance is retrieved by using a specific means of identification, and is used here to determine if the user has sufficient funds to use the desired amount in loyalty points.
\ncard_number (string): part of the user's identification which allows us to access details about the account holder, can be given as:amount (float): the amount that is being paid in dollars by the usersuccess: indicates if the request was successfully authorized by Spoonity or notamount: indicates the amount in dollars that was removed from the user's account, the amount of points actually removed varies based on individual loyalty systemstransaction_id: a reference number that only supplements the order, this number only references the payment itselfHere, details about the items in the order, discounts on these items, and discounts on the overall order are sent to our system to complete the sale. If the user is spending points on this order, this request removes them from the user's account. If there are any points to be gained on this order, this request will also add those points to the user's account. The appearance of the response of this request may change based on the structure of the loyalty system with each vendor. Once this order is complete, often the DEL onscreen_close request is called immediately to close the session.
\n\n\nNote: to see examples for both spending points and earning points, toggle between the two options at the top of the example request.
\n
card_number (string): part of the user's identification which allows us to access details about the account holder, can be given as:till (integer): only used for tracking and information purposes, and is not relevant to the order itselfreceipt_number (string): the invoice id from the point of salesubtotal (float): the only value that is used to calculate points earned from this ordertaxes (array): holds information about what taxes are on the order, not relevant to the calculation of pointstotal (float): the amount the customer actually pays, not relevant to the calculation of pointspayment_method (string): how the customer pays for the orderdate (integer): the date of this order, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00cashier (object, see Appendix below): used for tracking and information purposes, not relevant to the order itselfline_items (array of line_item objects, see Appendix below): holds information about each item in the orderdiscount (array of discount objects, see Appendix): holds objects that have information about discounts on the overall orderreference_number: the identification number that Spoonity uses to keep track of this order internallysuccess: indicates if the request was successfully authorized by Spoonity or notreceipt_data: holds information about the process that just occurred and information about the user indicated in the request, contains:lines: shows the process was successful in a way that is user friendlypoints: contains information about the points that are being used or earned, each object in this array containscurrency (see Appendix): an object that contains information about the type of currency being usedamount: indicates the quantity of the points that are being removed or addedexpiryDate: indicates the date that these points will expire, as a Unix timestamp in seconds from 1970-01-01 00:00:00user: contains more in depth information about the user making the order:id: an internal reference number that is unique to each usercard_number: the same card_number that was provided in the requestbalances: an array that contains information about the different balances a user has on their profile. Each object in balances contains:id: an internal reference number for the type of currencycurrency: indicates the type of currency in a way that is more user friendlybalance: the amount of this currency that is availabletype: indicates the category of payment being used{\n \"id\": \"1\",\n \"name\": \"Tony\"\n }\nid (string): an identification number assigned to a cashiername (string): the name of the cashier{\n \"id\": \"coffee\",\n \"name\": \"Regular Drip\",\n \"categories\": [],\n \"discounts\": [],\n \"price\": 2,\n \"quantity\": 1,\n \"modifiers\": []\n }\nid (string): an identification number that is unique to this itemname (string): identifies the item in a way that is more user friendlycategories (array): not relevant to the order, can be ignoreddiscounts (array of discount objects, see Appendix): holds objects that have information about a discount specific to this line itemprice (float): indicates the price of 1 unit of this item, must be a positive valuequantity (integer): indicates how many units of this item are being purchased on this ordermodifiers (array of line_items, see Appendix): contains information about items which modify the current item being ordered{\n \"id\": \"clover_discount\",\n \"name\": \"Free item\",\n \"amount\": 2\n }\nid (string): an identification number that is unique to this itemname (string): identifies the item in a way that is more user friendlyamount (float): indicates how much this discount is worth in dollars, must be a positive amount{\n \"id\": \"coffee\",\n \"name\": \"Regular Drip\",\n \"categories\": [],\n \"discounts\": [],\n \"price\": 2,\n \"quantity\": 1,\n \"modifiers\": []\n }\nid (string): an identification number that is unique to this itemname (string): identifies the item in a way that is more user friendlycategories (array): not relevant to the order, can be ignoreddiscounts (array of discount objects, see Appendix): holds objects that have information about a unique discountprice (float): indicates the price of 1 unit of this itemquantity (integer): indicates how many units of this item are being purchased on this ordermodifiers: each modifier has another array of modifiers, making it possible for modifiers to be nested infinitely{\n \"id\": 191,\n \"name\": \"Canadian Dollar\"\n }\nid: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendlyThis request uses the session hash key that was generated in the first call of this workflow to close the current session. In most cases, most recent session is closed once an order is complete, however this request can also be called manually.
\npos_session_hash: the hash value for the session that is being closedThe response will always be empty, however a status of \"200 OK\" indicates successful closure.
\n","urlObject":{"path":["onscreen"],"host":["{{endpoint}}"],"query":[{"key":"api_key","value":"{{apikey}}"}],"variable":[]}},"response":[{"id":"72755cde-cee9-4528-88c8-4d0a4967fd6e","name":"onscreen_close","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"pos_session_hash\": \"e777c6662bcfa23f327b9a8b07b7e50c\"\n}"},"url":{"raw":"{{endpoint}}/onscreen?api_key={{apikey}}","host":["{{endpoint}}"],"path":["onscreen"],"query":[{"key":"api_key","value":"{{apikey}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 14 May 2019 14:03:05 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2c30310c-67ff-4dd2-b51c-174f937f98ac"},{"name":"order_void","id":"769293db-0db1-402f-aac5-4ddb5d71787f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"receipt\": 17074472\n}"},"url":"{{endpoint}}/order/void?api_key={{apikey}}","description":"This request is used to void an order if necessary. Orders can only be voided in order from the most recent sale. To void a sale that was not the most recent, the more recent orders must be voided until the desired order to void is reached, that order must be voided, then the more recent orders must be re-applied in the sequence they occurred.
\nreceipt (integer): identifies which order is meant to be voided, matches the reference_number that is found in the response of the order_process (loyalty) requestvoided: indicates if this order was successfully voided or notThe customer checks into the vendor with a mobile application and includes information that we can use to identify them. This design is ideal for vendors that allow customers to make reservations, or that seat customers, so they can indicate when they are in store. Using the information the customer supplies on check in, we run a search against our API and determine the customer's account information.
\n - GET /onscreen/queue\n - GET /onscreen\nIn this step, the customer's account information can be used to determine if they have sufficient funds for the payment they are trying to authorize. After reviewing their balances, if it is determined that the customer has the funds, their account can be credited or debited according to the type of transaction they are authorizing.
\n - POST /order\n - POST /order/payments/loyalty\nHere, information relating to the items in this order, discounts on these items, and any discounts on the overall order are sent to our system to complete the sale.
\n - POST /order\nIn most cases, the session is automatically closed once the order process is complete, but the call to do this can also be done manually.
\n - DEL /onscreen\nThis request will cancel a transaction using the reference number from that order. It is important to note that this can only occur in order from the most recent sale. To void a sale that was not the most recent, more recent orders must be voided until the desired order is reached, that order voided, then the more recent orders must be re-applied in the sequence they occurred.
\n - POST /order/void\nThis request determines if the given email is linked with any account at Spoonity.
\nemail (string): passed in using query parameters, the email that is being attempted to be foundvendor (integer): passed in using query parameters, the vendor with which the email is being checkedexists: a boolean, true if this email exists, false otherwisevendor (see Appendix): an object that contains information about the vendor this email was first registered with{\n \"id\": 1,\n \"name\": \"Spoonity\"\n}\n\nid: the internal reference number used to identify the vendorname: identifies the vendor in a way that is more user friendlyThis request determines if a cedula is linked to any account at Spoonity.
\ncedula (string): passed in using query parameters, the cedula that is being searchedvendor (integer): passed in using the query parameters, the vendor with which the cedula is being checkedexists: a boolean, true if the cedula exists in our systemvalid: a boolean, true if the cedula provided is valid in the vendor's country of residencevendor: an object that contains information about the vendor this cedula was first registered with{\n \"id\": 1,\n \"name\": \"Spoonity\"\n}\nid: the internal reference number used to identify the vendorname: identifies the vendor in a way that is more user friendlyThis request determines if a mobile phone number is linked with any account at Spoonity.
\nmobile (string): passed in using query parameters, the desired mobile number to be foundcountry (string): passed in using query parameters, the two letter ISO 3166-1 code for the country this mobile number should be checked againstvendor (integer): passed in using query parameters, the id of the vendor with which the mobile number is being checkedavailable: a boolean, true if this is a valid phone number that is available to be registered, false otherwiseThis request is responsible for creating a profile for a new user. This sets up an account with basic user information such as first and last names, the user's email address, and the user's preferred language.
\nRequired parameters:
\nfirst_name (string): the first name of the user that is registeringlast_name (string): the last name of the user that is registeringanonymous (boolean): always set to falseemail_address (string): the email the user wants linked to their accountpassword (string): the password the user will use to access their accountterms (boolean): always set to truevendor (integer): the internal reference number associated with the specific vendor with which the user is registeringOptional parameters:
\nphone_number (see Appendix): an object containing information about the phone number to be linked to this accountbirthdate (integer): the user's date of birth as a Unix timestamp in seconds from 1970-01-01 00:00:00language (integer, see Appendix): an internal reference number that indicates the user's preferred languagecedula (string): the cedula of the user that is registering, only needed in South Americacontact_consent (integer, see Appendix): an internal reference number that represents the user's consent to being contactedid: an internal reference number associated with this userfirst_name: the first name the user registered withlast_name: the last name this user registered withemail_address: the email address this user registered withbirthdate: the user's date of birth if it was included as a Unix timestamp in seconds from 1970-01-01 00:00:00date_created: the date this account was created as a Unix timestamp in seconds from 1970-01-01 00:00:00date_updated: the date this account was last updated as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that holds information about the current status of the user{\n \"code\": \"1\"\n \"number\": \"1234567890\",\n}\ncode (string): the country code associated with this numbernumber (string): the user's phone number{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the status of the username: indicates the user's current status in a way that is more user friendlyPossible values and their corresponding meanings for this integer:
\n1 = en (English)\n2 = fr (French)\n3 = es (Spanish)\n4 = ar (Arabic)\nPossible values and their corresponding meanings for this integer:
\n0 = no contact was enabled\n1 = only email contact was enabled\n2 = only SMS contact was enabled\n3 = both email and SMS contact was enabled\nThis request authenticates a user's credentials and creates a login session. Here, information about the user as it applies to this vendor is returned. The session identifier value is crucial to accessing this current login session at any given time.
\nemail_address (string): the email with which the user registered their accountpassword (string): the password with which the user registered their accountvendor (integer): the internal reference number for the vendor with which the user is attempting to log infirst_login: a boolean value indicating if this is the user's first login to this vendor with this accountonline_order_token: unique to this login session, allows a specific third party to access this same login session, in most cases this is safe to ignorevendor_user: in this case will always be null, safe to ignoresession_identifier: a key unique to this current login sessionuser_vendor: an object that contains information about the user that is specific to this vendor, this object contains:language (see Appendix): an object that holds information about the language the user selected with this vendorvendor: an object that holds information about the current vendoranonymous: a boolean set with account registration, always falsereload_amount: how much a user has indicated to reload automatically with automatic reloadreload_threshold: the point at which the user's account will automatically reloadcontact_consent (see Appendix): an integer indicating if the user has allowed the vendor to contact themcreated: the date the account was created with this vendor, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00billing_profile: the internal reference number of the billing profile used for automatic reloadtier (see Appendix): an object that contains information about the prestige level of the user with the current vendortier_since: the date this user reached this tier, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user (see Appendix): an object that contains information about the current user{\n \"code\": \"en\",\n \"id\": 1,\n \"name\": \"English\"\n}\ncode: the two letter ISO 639-1 code associated with this languageid: the internal reference number Spoonity uses to identify this languagename: identifies the language in a way that is more user friendly{\n \"id\": 1,\n \"name\": \"Spoonity\"\n}\nid: the internal reference number used to identify the vendorname: identifies the vendor in a way that is more user friendlyPossible values and their corresponding meanings for this integer:
\n0 = no contact was enabled\n1 = only email contact was enabled\n2 = only SMS contact was enabled\n3 = both email and SMS contact was enabled\n{\n \"id\": 12,\n \"name\": \"Default\",\n \"summary\": \"\",\n \"description\": \"\"\n}\nid: an internal reference number unique to each tiername: identifies the tier in a way that is more user friendlysummary: a summary of the perks offered at this tierdescription: a description of the current tier{\n \"id\": \"582846\",\n \"first_name\": \"brandin\",\n \"last_name\": \"chiu\"\n}\nid: an internal reference number unique to each userfirst_name: the user's first namelast_name: the user's last nameThis request activates a user's account. The user must have an active login session, and must have received an activation token in an email or SMS. This token is necessary to activate the account.
\ntoken (string): passed in using query parameters, the value that was sent to the user via emailsession_identifier (string): passed in using query parameters, must match the session identifier key found in the response of the user_authenticate requestThe response will always be empty, however a status code of 200 OK indicates successful activation.
\n","urlObject":{"path":["user","activate"],"host":["{{endpoint}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"session_identifier","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"a1bebc6d-e3a8-4cf8-9248-3cceee5743c3","name":"user_activate_create","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/user/activate?token={{token}}&session_identifier={{user_session_key}}","host":["{{endpoint}}"],"path":["user","activate"],"query":[{"key":"token","value":"{{token}}"},{"key":"session_identifier","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 May 2019 15:13:40 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"dfecff71-bf04-46f4-b445-3bba55a71e32"},{"name":"user_send_activation_email_read","id":"26817795-15b2-4b9b-b005-44c25768b86a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/activate/email?session_identifier={{user_session_key}}","description":"This request sends an email to the user currently logged into the given session, this email contains the information necessary to verify that email address.
\nsession_identifier (string): passed in through the query parameters, must match the session identifier key created with the user_authenticate requestThe response will always be empty, however a status code of 200 OK will indicate the email was sent successfully.
\n","urlObject":{"path":["user","activate","email"],"host":["{{endpoint}}"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"ea207a56-11ee-4168-a4d9-483b0b63e25c","name":"user_send_activation_email_read","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/user/activate/email?session_identifier={{user_session_key}}","host":["{{endpoint}}"],"path":["user","activate","email"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 13:27:42 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"26817795-15b2-4b9b-b005-44c25768b86a"},{"name":"user_send_activation_sms_read","id":"08d4b15e-77fd-4213-95b9-18a68b6af499","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/activate/sms?session_identifier={{user_session_key}}&phone={{phone}}&country=CA","description":"This request sends an SMS message to the user currently logged into the given session, and contains the information necessary to verify the mobile number on the account. If the user would like to change the mobile number this SMS message is sent to, extra query parameters phone and country must be included.
session_identifier (string): passed in through the query parameters, must match the session identifier key created with the user_authenticate requestphone parameter can be included, allowing the user to change the phone number during SMS validation (in case of error). When this parameter is included, it is also necessary to have:country (string): the two letter ISO 3166-1 code that indicates which country this phone number is registered inThe response will always be empty, however a status code of 200 OK will indicate the SMS message was sent successfully.
\n","urlObject":{"path":["user","activate","sms"],"host":["{{endpoint}}"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"},{"key":"phone","value":"{{phone}}"},{"key":"country","value":"CA"}],"variable":[]}},"response":[{"id":"92d52f80-9ee9-4268-bde3-7620402a8681","name":"user_send_activation_sms_read","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/user/activate/sms?session_identifier={{user_session_key}}","host":["{{endpoint}}"],"path":["user","activate","sms"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"},{"key":"phone","value":"{{phone}}","disabled":true},{"key":"country","value":"CA","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 13:28:38 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null},{"id":"b83b8a71-b917-4dc9-9564-001b06e18165","name":"user_send_activation_sms_read (error)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/user/activate/sms?session_identifier={{user_session_key}}","host":["{{endpoint}}"],"path":["user","activate","sms"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"},{"key":"phone","value":"{{phone}}","disabled":true},{"key":"country","value":"CA","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 14:40:14 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"406"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 0,\n \"reference_id\": null,\n \"more_info\": \"http://api.spoonity.com/doc/#apiMethod\",\n \"errors\": [\n {\n \"reason\": \"exception\",\n \"message\": \"There was an error trying to verify your number, please try again. If the problem persists, please contact support.\"\n }\n ]\n },\n \"object\": \"error\"\n}"}],"_postman_id":"08d4b15e-77fd-4213-95b9-18a68b6af499"},{"name":"user_is_validated","id":"14d4d222-bfde-4d0d-9732-cbaaccbb2b5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/isValidated?session={{user_session_key}}","description":"This request checks if a user is validated at a specific vendor. The session key gives access to information about which user has activated this session and with what vendor, making it unnecessary to supply any other information.
\nsession (string): passed in using query parameters, must match the session identifier found in the response of the user_authenticate requestisValidated: a boolean, true if the user is validated, false if notphone_number: the phone number associated with this usermethods: an array verification methods that are enabled with this vendor, user must have at least one of these verified in order to be validated status: an object that holds information about the status of validation for this userNo Verification: a boolean, true if the user has had their validation overridden by the vendor and does not have to validate their account, false otherwiseEmail: a boolean, true if the user has validated their account through email, false otherwiseSms: a boolean, true if the user has validated their account through SMS, false otherwiseThis request uses the session identifier key that was generated in the user_authenticate request to log out of the session.
\nsession_key (string): passed in using query parameters, must match the session identifier key that was created with the user_authenticate requestThe response will always be empty, however a status code of 200 OK indicates successful logging out.
\n","urlObject":{"path":["user","logout"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"ec7faee2-f48d-4036-a31d-e7cf0de09e62","name":"user_logout","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":{"raw":"{{endpoint}}/user/logout?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","logout"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 14:42:22 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b2721cd9-738f-454f-a7f9-86a047cb15a0"},{"name":"user_password_reset_reset","id":"22a2d9ba-5f08-46b9-bf85-1f21faf49e3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email_address\": \"brandin@spoonity.com\",\n\t\"vendor\": 1\n}"},"url":"{{endpoint}}/user/password-reset/reset","description":"With this request, the user can reset the password linked to their account. This request is used when a user indicates they forgot their password, so the user must only supply an email address to receive the reset information. An email is sent to the given address with a \"token\", which must be sent with the next request to finalize the password reset.
\nemail_address (string): the email address for the account for which the password is being reset vendor (integer): the internal reference number for the vendor with which the user is resetting their passwordThe response will always be empty, however a status 200 OK code indicates the email was sent to the user.
\n","urlObject":{"path":["user","password-reset","reset"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"6d01145c-bac8-436d-8382-6ed713fe9519","name":"user_password_reset_reset","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email_address\": \"brandin@spoonity.com\",\n\t\"vendor\": 1\n}"},"url":"{{endpoint}}/user/password-reset/reset"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 May 2019 15:39:49 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"22a2d9ba-5f08-46b9-bf85-1f21faf49e3e"},{"name":"user_password_reset_apply","id":"58ee4b78-eec2-4ef7-b72f-576a9f037413","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"8ac39a5f61785061a6c4a1c8abe8dd9c\",\n\t\"password\": \"Spoonity1\"\n}"},"url":"{{endpoint}}/user/password-reset/apply","description":"The token sent in the email to the user is used in this request to access the user's account and apply the new password. Requiring this token adds an extra measure of security, as it means the user is authorized to access to the email that is linked to the account being changed. Without this, any user could change the password to any given account for which they know an email address, regardless of authorization to access that email or Spoonity account ownership.
\ntoken (string): the value that was sent to the customer via the email they entered in the previous requestpassword (string): the new password for this user's accountThe response will always be empty, however a status code of 200 OK will indicate that the new password was applied.
\n","urlObject":{"path":["user","password-reset","apply"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"b806495d-72ae-4a09-b602-34b1fdbeac75","name":"user_password_reset_apply","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"8ac39a5f61785061a6c4a1c8abe8dd9c\",\n\t\"password\": \"Spoonity1\"\n\n}"},"url":"{{endpoint}}/user/password-reset/apply"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 14:44:03 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"58ee4b78-eec2-4ef7-b72f-576a9f037413"}],"id":"a31ecdc1-0cb0-4574-b8a9-c57d2d76ec02","description":"A new user registers for an account. The /exists requests are designed to be used as helper methods to assist with front end validation, but their use is not mandatory. The register request sends the new user's information to our systems to create a new profile.
- GET /user/email/exists\n - GET /user/cedula/exists\n - GET /user/mobile/exists\n - POST /user/register\nThe user's email and password are required to log into their account. These pieces of information are sent to our system for authentication, and the user's login session is returned along with information relevant to the vendor with which they have logged in. When the user decides to log out of their account, the session information is used to access the login session and do so.
\n - POST /user/authenticate\n - POST /user/logout\nOften, vendors require users to validate their account, to ensure the account information supplied by the user is valid and belongs to a real person. A token, sent via email or SMS to the user for security, and the user's current login session are both necessary for this account activation. Once the user has activated their account, their validation will hold a value of true with this vendor.
\n - GET /user/activate\n - GET /user/activate/email\n - GET /user/activate/sms\n - GET /user/isValidated\nThese requests are necessary when a user has forgotten the password they linked to their account. In order to reset the password, a token is sent to the user via their email. This token is used to apply the user's new password to their account.
\n - POST /user/password-reset/reset\n - POST /user/password-reset/apply\nThis request is used to get a user's profile information. The session_identifier that was produced on the user's login is used to fetch general information about the user such as their address, first and last names, push notification settings, contact consent settings, etc. This request will also return any optional information that is linked to the user's account, such as a user's favourite location if this has been specified.
\nsession_key (string): passed in through the query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowanonymous: a boolean, always set to falsebilling_profile (see Appendix): the user's billing profile that is selected for automatic reload, null if this feature is disabledcontact_consent (see Appendix): an internal reference number that represents the user's consent to be contacted by this vendorcreated: the date this user's profile was created with this specific vendor, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00flagged: a boolean, true if this user's account has been flagged for suspicious or fraudulent behaviourid: an internal reference number that links the user's account to this specific vendoris_verified (see Appendix): an object that indicates if the user is verified or not, similar to the response of the user_is_validated request in the \"Registering an account\" workflowlanguage (see Appendix): an internal reference number indicating the language that the user has specified to usemetadata (see Appendix): an array of objects that each store details about information that is surplus to the user's required profile dataonline_order_token: unique to this login session, allows a specific third party to access this same login session, in most cases this is safe to ignorepush_endpoints (see Appendix): unique id that can be used to send the user push notificationsreferral_url: a url that this user can share with a new user to earn points or apply a discount to both accountsreload_amount: how much a user has indicated to reload automatically with automatic reloadreload_threshold: the point at which the user's account will automatically reloadstatus (see Appendix): an object that contains information about the current status of the userupdated: the last date this profile was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user (see Appendix): an object that contains information about the user whose profile is being readvendor: an object that is always returned empty, safe to ignore{\n card: \"4242 xxxx xxxx 4242\",\n created: 1562871344,\n expiry: 1564531200,\n id: \"69235\",\n name: \"nickname\",\n object: \"user_billingprofile\",\n status: {},\n type: \"Visa\",\n updated: 1563299711\n}\n\ncard: the first and last 4 digits of the credit card number linked to this profile
created: the date this billing profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
expiry: the expiry date found on this card, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
id: an internal reference number that identifies this billing profile
name: user specific card reference, as it was entered in the description when the card was added
status: (see Appendix): an object that contains information about the current status of the billing profile
type: indicates the type of card in a way that is user friendly
updated: the last date this billing profile was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
Possible values and their corresponding meanings for this integer:
\n0 = no contact was enabled\n1 = only email contact was enabled\n2 = only SMS contact was enabled\n3 = both email and SMS contact was enabled\n\n{\n \"status\": true,\n \"methods\": {\n \"No Verification\": false,\n \"Email\": true,\n \"Sms\": true\n }\n\nstatus: a boolean, true if the user is validatedmethods: an object that holds information about the enabled verification methods with this vendor, each object contains:No Verification: a boolean, true if the user has had their validation overridden by the vendor and does not have to validate their account, false otherwiseEmail: a boolean, true if the user has validated their account through email, false otherwiseSms: a boolean, true if the user has validated their account through SMS, false otherwisePossible values and their corresponding meanings for this integer:
\n1 = en (English)\n2 = fr (French)\n3 = es (Spanish)\n4 = ar (Arabic)\n\n{\n \"user_metadata_id\": \"6770055\",\n \"user_metadataField_id\": 7,\n \"field\": \"Address\",\n \"value\": \"123 Smith St\",\n \"validation\": null,\n \"input_type\": null\n }\n\nuser_metadata_id: an internal reference number that is unique to each user metadata objectuser_metadataField_id: an internal reference number that refers to the type of information help by this objectfield: indicates the type of information stored in this object in a way that is more user friendlyvalue: the input for this type of information as it applies to the user{\n \"gcm\": [],\n \"apns\": []\n }\n\ngcm and apns are arrays that hold information for push notifications{\n \"id\": 1,\n \"name\": \"Active\"\n }\n\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly{\n \"object\": \"user\",\n \"id\": 1000454652210,\n \"cid\": null,\n \"facebook_identifier\": null,\n \"email_address\": \"grace@spoonity.com\",\n \"first_name\": \"Grace\",\n \"last_name\": \"Duncan\",\n \"phone_number\": \"11234567890\",\n \"passport_number\": null,\n \"address\": {\n \"address1\": \"123 Smith St\",\n \"address2\": \"\",\n \"city\": \"\",\n \"region\": null,\n \"country\": null,\n \"postal_code\": \"\"\n },\n \"birthdate\": 845856000,\n \"pet\": {\n \"name\": null,\n \"date_of_birth\": null\n },\n \"created\": 1558967253,\n \"updated\": 1559225428,\n \"status\": {}\n }\n\nid: an internal reference number that is unique to each usercid: safe to ignoreemail_address: the user's email addressfirst_name: the user's first namelast_name: the user's last namephone_number: the user's phone numberpassport_number: the user's passport numberaddress (see Appendix): an object that holds information about the user's addressbirthdate: the user's birthdate, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00created: the date the user's profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00updated: the last date this user's profile was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see above Appendix entry): an object that contains information about the current status of the user{\n \"address1\": \"123 Smith St\",\n \"address2\": \"\",\n \"city\": \"\",\n \"region\": null,\n \"country\": null,\n \"postal_code\": \"\"\n}\n\naddress1: the first line of the user's addressaddress2: the second line of the user's address, if applicablecity: the user's cityregion: an object that contains information about the user's regionregion_id: an internal reference number unique to each regionname: indicates the region in a way that is more user friendlycountry: an object that holds information about the user's countrycountry_id: an internal reference number unique to each countryname: indicates the country in a way that is more user friendlypostal_code: the user's postal or zip codeThis request is used to update information on a user's account. If only one piece of information is being updated, only that parameter has to be sent with the request. If multiple pieces of information are being updated, multiple parameters can be sent with one request to do this. This request can be used to change things such as a user's password, email, or address.
\nEach of these parameters are optional, it is only necessary to include the parameters that are being updated.
\n\n\nNote: if email or password is being updated,
\ncurrent_password(string) must also be included
address1 (string): the user's updated addresscity (string): the user's updated cityregion (integer): the user's updated region as the internal reference number to this regioncountry (integer): the user's updated country as the internal reference number to this regionpostal_code (string): the user's updated postal or zip codephone_number (object, see Appendix): an object that contains information necessary to update the user's phone numberpassword (string): the user's updated password, must include parameter current_passwordemail_address (string): the user's updated email, must include parameter current_passwordlanguage (integer, see Appendix): the user's updated language preference as the internal reference number for this languagecontact_consent (integer, see Appendix): the user's updated consent preferences as the internal reference number to this preferencefirst_name (string): the user's updated first namelast_name(string): the user's updated last namestatus (object, see Appendix): an object that contains the information necessary to update the user's statusmetadata (object, see Appendix): an object that contains the information necessary to update a metadata valueThe response will always be empty however a status code of 200 OK indicates the profile was updated successfully
\n{\n \"number\": \"1234567890\",\n \"code\": \"1\"\n}\n\nnumber (string): the user's updated phone numbercode (string): the country code associated with this numberPossible values and their corresponding meanings for this integer:
\n1 = en (English)\n2 = fr (French)\n3 = es (Spanish)\n4 = ar (Arabic)\n\nPossible values and their corresponding meanings for this integer:
\n0 = no contact was enabled\n1 = only email contact was enabled\n2 = only SMS contact was enabled\n3 = both email and SMS contact was enabled\n\n{\n \"id\": 1,\n \"name\": \"Active\"\n }\n\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly{\n \"user_metadata_id\": \"6770055\",\n \"user_metadataField_id\": 7,\n \"field\": \"Address\",\n \"value\": \"123 Smith St\",\n \"validation\": null,\n \"input_type\": null\n }\n\nuser_metadata_id: an internal reference number that is unique to each user metadata objectuser_metadataField_id: an internal reference number that refers to the type of information this object holdsfield: indicates the type of information stored in this object in a way that is more user friendlyvalue: the input for this type of information as it applies to the userThis request returns a unique token and barcode for the user. This barcode can be used to identify the user on check in when placing an order.
\nsession_key (string): passed in through the query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowtoken_type (integer): a static value that is always 2barcode: raw image data that can be used to identify user on check increated: the date this token was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry: the date this token will expire, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that is unique to each tokenstatus (see Appendix): an object that contains information about the current status of this tokentoken: holds the same information encoded in the barcode, in string formtype: a reference number for the type of token being returned, always the same so safe to ignoreupdated: the last date this token was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user: an empty object, safe to ignorevendor: an empty object, safe to ignore{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyThis request is called when a user indicates they would like to delete their account. An email is sent to the customer with a code that will allow them to confirm the deletion process.
\nvendor (integer): passed in using the url directly, the internal reference number for the vendor with which that account is being deleteduser (integer): passed in using the url directly, the internal reference number for the user's account that is to be deletedsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowThe response will always be empty, but a status code of 204 No Content indicates an email was successfully sent.
\n","urlObject":{"path":["vendor","{{vendor}}","customers","{{user}}","submit"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"4245ecba-7d72-4203-b971-91a6b76a9b48","name":"user_delete_submit","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{}"},"url":{"raw":"{{endpoint}}/vendor/{{vendor}}/customers/{{user}}/submit?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["vendor","{{vendor}}","customers","{{user}}","submit"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Thu, 30 May 2019 17:09:13 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, x-requested-with, API-SESSION, Content-Type, Content-Range, Content-Disposition, Content-Description"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, no-cache, no-store, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"23cd6f30-8a1f-4669-ba84-75a9e755afd8"},{"name":"user_delete","id":"80abfa0a-4864-4e93-bcd0-4b646e81e480","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"code\": \"aca0a733c0ba5a8afde59ce6d6f4dbf3\"\n}"},"url":"{{endpoint}}/vendor/{{vendor}}/customers","description":"The code received by the user via their email is sent to our system using this request, along with the vendor with which this account is being deleted. This request is responsible for the actual deletion of the user's account.
\nvendor (integer): passed in using the url directly, the internal reference number for the vendor with which this user's account is being deletedcode (string): the code that the user received via emailThe response returns an empty array, and a status code 200 OK indicates the account was successfully deleted.
\n","urlObject":{"path":["vendor","{{vendor}}","customers"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"ce9f289d-24ea-4d82-ba43-739f3dafbbaa","name":"user_delete","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"code\": \"aca0a733c0ba5a8afde59ce6d6f4dbf3\"\n}"},"url":"{{endpoint}}/vendor/1/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2019 17:11:21 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, x-requested-with, API-SESSION, Content-Type, Content-Range, Content-Disposition, Content-Description"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, no-cache, no-store, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"2"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"80abfa0a-4864-4e93-bcd0-4b646e81e480"},{"name":"user_quickpay_balance","id":"3fcc74bd-4d07-418e-8b15-b1538f2ec553","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/quick-pay/balance?session_key={{user_session_key}}","description":"This request is used to check the user's quick pay balance on their account.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowamount: the quantity of quickpay balance the user has on their accountcurrency (see Appendix): an object that contains information about the type of currency being used{\n \"code\": \"CAD\"\n \"id\": 191,\n \"name\": \"Canadian Dollar\",\n }\ncode: the ISO 4217 code associated with this type of currency, a null value indicates a loyalty currencyid: the internal reference number for the type of currencyname: indicates the type of currency in a way that is more user friendlyThis request is used to check all balances on a user's account, both quickpay and loyalty balances are returned.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowAn array of two objects where one is quick pay and one is points. Each contains:
\ncurrency: an object that contains information about what currency is being usedcurrency_id: an internal reference number that indicates what currency is in usename: indicates the currency in a way that is more user friendlycurrencyType: an object that holds information about the type of currency being usedcurrencyType_id: an internal reference number that indicates the type of currency being usedname: indicates the type of currency being used in a way that is more user friendlystatus (see Appendix): an object that contains information about the current status of this currencybalance: indicates the amount of this currency that is on this accountexpiring: an array of objects that give information about the date of expiry of this loyalty balance (as a Unix timestamp in seconds from 1970-01-01 00:00:00), and the quantity of the balance that expires on this date{\n \"status_id\": 1,\n \"name\": \"Active\"\n }\nstatus_id: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyThis request returns a list of rewards this user is eligible for with this vendor, as well as information about the user's tier.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowbalances: an array of objects that hold information about the balances of each currency on this user's accountid: an internal reference number that indicates which currency is being referencedname: indicates the currency being referenced in a way that is more user friendlybalance: shows the balance of this currency on this user's accountcount: indicates the number of rewards this user has availabledata: an array of objects that hold information about each vendor reward this user has availablecatalog: an object that contains information about how this reward is invokedid: an internal reference number that refers to the line_item (see order_process (loyalty) in \"Placing an order\") that invokes this redemption rulename: indicates the line_item that invokes this redemption rule in a way that is more user friendlysummary: a brief overview of what the reward is and what points will be removedtemplate (see Appendix): the style type for how the perk should be displayedtype: an object that holds information about the type of reward being offeredid: an internal reference number that indicates the type of reward being offeredname: indicates the type of reward being offered in a way that is more user friendlyid: an internal reference number unique to each rewardcurrency (see Appendix): an object that contains information about the type of currency being usedname: indicates the reward in a way that is more user friendlydescription: a description of what the reward entailscost: the amounot of points this reward requires to be redeemedavailable: how many of these rewards the user is able to redeem with their current loyalty balanceprogress: the number of points the user has towards qualifying for a reward of this typeexpiring (see Appendix): an object that holds information about when this reward will expirenext_page_url, previous_page_url: direct urls linking the user to the next and previous pages of resultspage, page_size, total_pages: integers denoting the page number, page size, and the total number of pagestier: an object that holds information about the prestige level of the usercount: total number of tiers this vendor hascurrent: an object that holds information about the user's current tierdescription: a description of the current tierid: an internal reference number that indicates the user's current tiersummary: a summary of the rewards offered at the current tiername: indicates the name of the current tier in a way that is more user friendlysince: the date this tier was achieved, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00next: an object that contains information about the next tier level to be attainedid: an internal reference number for the next tiername: indicates the name of the next tier in a way that is more user friendlyprogress: the number of criteria the user currently has towards reaching the next tieramount: the number of criteria required to achieve this tiersummary: a summary of the perks offered at the next tierdescription: a description of the next tierall: an object that contains information about all possible tiers with this vendorvendor_tier_changed: the last date the user's tier changed, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00 tier_immunity_days: a configuration value from the vendor, indicates how long a user has on this tier before being downgradeddays_remaining: the time left between now and when the user will be downgradeddata: an array of objects that each hold information about one tier, one object for each tier holds the same information found in next{\n \"id\": 2,\n \"name\": \"POINT\"\n }\nid: an internal reference number that is unique to each templatename: indicates the template style in a way that is more user friendly{\n \"id\": 191,\n \"name\": \"Canadian Dollar\",\n }\nid: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendly{\n \"data\": []\n }\ndata: an array of objects that give information about the date of expiry of this loyalty balance (as a Unix timestamp in seconds from 1970-01-01 00:00:00), and the quantity of the balance that expires on this dateThis request returns a list of the user's most recent transactions, ordered from newest to oldest. Only transactions that involved spending or earning quickpay or loyalty currencies are returned here. This request allows the user to observe changes in their account balances.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowcount: the total number of transactions returned with this response
next_page_url, previous_page_url: direct urls linking the user to the next and previous pages of results
page, page_size, total_pages: integers denoting the page number, page size, and the total number of pages
data: an array of objects that each hold information about previous transactions, ordered newest to oldest
rating: an object that holds information about the rating of this transaction
comment: the feedback from the customer regarding this transaction
value: the value of the rating on a scale of 0-100, where 0 is bad, 100 is good, and -1 indicates there was no rating provided for this transaction
window: an integer that indicates the number of hours available to leave a rating, in reference to the time of the order
tip: an object that contains information about the tip on this transaction
amount: the value of the tip given on this transaction
window: an integer that indicates the number of hours available to leave a tip, in reference to the time of the order
id: the internal reference number for this specific transaction
date: the date this transaction was completed, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
total: usually the same as subtotal, safe to ignore as does not affect the calculation of points
address: the address of the store where this transaction occurred
name: the name of the store where this transaction occurred
quickpay: an object that holds information regarding the changes in quickpay balance for this transaction
used: indicates the amount of quickpay that was redeemed on this order
loaded: indicates the amount of quickpay that was added on this order
balance: the current balance of this users quickpay, as of this transaction
items: an array of objects where each object holds information about an item on this order
type: an internal reference number that indicates the catalog type of item (eg. discount/product/etc)
name: indicates the item in a way that is user friendly, as assigned by the vendor
quantity: how many of these items were ordered
price: the price of one of these items
id: an internal reference number specific to this item
loyalty: an array of objects that each contain information about a change in the loyalty balance for this transaction
transaction_detail_id: an internal reference number specific to this change of loyalty balance
currency (see Appendix): an object that contains information about the type of currency being used
amount: how many loyalty points were added to or removed from the user's account
taxes: usually an empty array, can safely be ignored
receipts: holds the receipt information for this transaction
date: the date this transaction occurred, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
subtotal: indicates the subtotal of the overall order
id: an internal reference number for this order
number: the receipt number as assigned to this transaction by the point of sale
cashier: the cashier that completed this transaction
workstation: the identifier for the workstation used for this transaction, as supplied by the point of sale
reward: an array of objects that each contain information regarding the rewards redeemed or earned on this transaction
expired: indicates if this reward is expired
expiry_date: if reward is expired, the date this reward expired, a Unix timestamp in seconds from 1970-01-01 00:00:00, otherwise set to NULL
name: indicates the current reward in a way that is more user friendly
id: an internal reference number that indicates the current reward
spent: the number of loyalty points redeemed with this reward
earned: the number of loyalty points earned with this reward
balance: the current loyalty balance after this reward was applied
perks: an array indicating the earning rules that were applied to this transaction
redemptions: an array indicating the spending rules that were applied to this transaction
status: indicates the status of the transaction in a way that is user friendly
{\n \"id\": 961,\n \"name\": \"Points\",\n}\n\nid: an internal reference number that indicates the type of currency
name: indicates the type of currency in a way that is more user friendly
This request returns a list of the user's most recent transactions, ordered from newest to oldest. All transaction types are included here, including adjustments from support or from the vendor. This request allows the user to observe changes in their account balances.
\nThis request can be completed using an api_key or a valid session_key supplied in the query parameters. If using a session_key, it must match the session identifier found in the response of the user_authenticate request for the customer defined in the URL.
data: an array of objects that each hold information about previous transactions, ordered newest to oldest
receipt_id: an internal reference number for this receipt
receipt_number: the receipt number as received from the POS
receipt_date: indicates the date associated with the receipt as received from the POS, as a Unix timestamp in seconds from 1970-01-01 00:00:00
receipt_type: indicates the receipt type in a way that is user friendly
date_created: indicates the date that this record was created, as a Unix timestamp in seconds from 1970-01-01 00:00:00
date_updated: indicates the date that this record was updated, as a Unix timestamp in seconds from 1970-01-01 00:00:00
subtotal: the value that was used to calculate points earned from this order, as received from the POS
total: the amount the customer actually pays, not relevant to the calculation of points, as received from the POS
total_with_tips: the total amount including any tips, as indicated on the order received from the POS
is_online_order: a boolean indicating if this transaction was an online order
feedback: any feedback associated with this this order, as received from the POS
vendor: an object that contains information about the vendor this order has been created through
vendor_id: an internal reference number that is unique to each vendor
name: indicates the current vendor in a way that is more user friendly
address: the vendor's street address
city: the vendor's city
region: an object indicating the vendor's region
country: an object indicating the vendor's country
postal_code: the vendor's postal code
latitude: the vendor's latitude
longitude: the vendor's longitude
line_items: (array of line_item objects, see Appendix below): holds information about each item in the order
global_discounts: (array of discount objects, see Appendix): holds objects that have information about discounts on the overall order
loyalty: (see Appendix for \"expired\" case) an array of objects that each contain information about a change in the loyalty balance for this transaction
transaction_detail_id: an internal reference number specific to this change of loyalty balance
perk: an object with information about the perk attached to the this transaction
vendor_perk_id: an internal reference number that is unique to each perk
name: indicates the name of the perk in a way that is more user friendly
redemption: an object with information about the redemption attached to the this transaction
vendor_perk_redemption_id: an internal reference number that is unique to each redemption
name: indicates the name of the redemption in a way that is more user friendly
currency (see Appendix): an object that contains information about the type of currency being used
amount: how many loyalty points were added to or removed from the user's account
type: indicates the type of transaction in a way that is user friendly
status: indicates the status of the transaction in a way that is user friendly
expiry_date: indicates the date that points earned on this transaction expire, as a Unix timestamp in seconds from 1970-01-01 00:00:00
charge: (see Appendix) an object indicating if the transaction has a credit card charge associated to the loyalty record, typically only present for gift card based transactions
paging: an object containing information surrounding paging
next, previous: direct urls linking the user to the next and previous pages of results{\n \"id\": \"coffee\",\n \"name\": \"Regular Drip\",\n \"categories\": [],\n \"discounts\": [],\n \"price\": 2,\n \"quantity\": 1,\n \"modifiers\": []\n}\n\nid (string): an identification number that is unique to this item
name (string): identifies the item in a way that is more user friendly
categories (array): not relevant to the order, can be ignored
discounts (array of discount objects, see Appendix): holds objects that have information about a discount specific to this line item
price (float): indicates the price of 1 unit of this item, must be a positive value
quantity (integer): indicates how many units of this item are being purchased on this order
modifiers (array of line_items, see Appendix): contains information about items which modify the current item being ordered
{\n \"id\": \"clover_discount\",\n \"name\": \"Free item\",\n \"amount\": 2\n}\n\nid (string): an internal reference that is unique to this item
name (string): identifies the item in a way that is more user friendly
amount (float): indicates how much this discount is worth in dollars, must be a positive value
For \"Expired\" receipt types, there will be at least two loyalty objects as defined in the response section above. One indicates the first transaction that earned points and when those points expire, and the other object indicates the second transaction that expired the points. The second object will have a type of \"Expired\" and a negative amount.
\"loyalty\": [\n {\n \"transaction_detail_id\": 1234,\n \"perk\": {\n \"vendor_perk_id\": 111,\n \"name\": \"Earn Points\"\n },\n \"redemption\": null,\n \"currency\": {\n \"currency_id\": 222,\n \"name\": \"Points\",\n \"code\": null\n },\n \"amount\": 1,\n \"type\": \"Awarded\",\n \"status\": \"Complete\",\n \"expiry_date\": 1753203439,\n \"charge\": null\n },\n {\n \"transaction_detail_id\": 1334,\n \"perk\": null,\n \"redemption\": null,\n \"currency\": {\n \"currency_id\": 222,\n \"name\": \"Points\",\n \"code\": null\n },\n \"amount\": -1,\n \"type\": \"Expired\",\n \"status\": \"Complete\",\n \"expiry_date\": null,\n \"charge\": null\n }\n]\n\n{\n \"id\": 961,\n \"name\": \"Points\",\n}\n\nid: an internal reference number that indicates the type of currency
name: indicates the type of currency in a way that is more user friendly
{\n \"user_billingProfile_id\": 123,\n \"card_mask\": \"3333\",\n \"reference_number\": 123456789,\n \"success\": true\n}\n\nuser_billingProfile_id: an internal reference number unique to each billing profile
card_mask: returns the last 4 digits of the credit card number linked to this profile
reference_number: an identitifier that matches this charge to the transaction, as received from the payment gateway or card provider
success: true if the transaction was successful, false otherwise
This request returns a list of all the countries this vendor serves. This is designed to be a helper request for form building.
\nThere are no parameters required for this request.
\nThis request returns an array of country objects, each object contains:
\ncountry_id: an internal reference number unique to each countrycode: the two letter ISO 3166-1 code associated with this countryname: indicates the country in a way that is more user friendlyphone_code: this country's calling codezip_validate: used to validate a postal or zip code for this countryphone_validate: used to validate a phone number for this countryflag_url: a url that links this country's flagThis request returns a list of all the regions within a specific country this vendor serves. This is designed to be a helper request for form building.
\ncountry (integer): provided via the url directly, the internal reference number for the country whose regions are being listedThis request returns an array of region objects, each object contains:
\nregion_id: an internal reference number unique to each regioncode: the ISO 3166-2 subdivision code for this regionname: indicates the region in a way that is more user friendlyThese requests are used to access a user's profile. The session key created on user login is used to access general information about the user. Any information on the user's account can be updated, such as address, phone number, language, email address, and password.
\n - GET /user/profile\n - PUT /user/profile\nEach user has a token, which is linked to their unique card number and carries information about their account. This token can be given as a barcode, which can be used to check in and create an onscreen session.
\n - POST /user/token/request\n \nA user must be logged in to delete their account. The login session key is used to identify the account and send a confirmation email. This email includes a code which must be supplied in the actual deletion request as a measure of security. Once this code is submitted, the user's account is deleted.
\n - DELETE /vendor/{vendorID}/customers{userID}/submit\n - DELETE /vendor/{vendorID}/customers\nThese requests are used to access the quickpay and loyalty point balances a user has on their account. Information about the rewards the user is eligible for with the specific vendor they have logged in to can be also found.
\n - GET /user/quick-pay/balance\n - GET /user/currency/balance\n - GET /user/reward/list\nReturns a list of all prior transactions for this user that resulted in a change in loyalty or quickpay balances.
\n - GET /user/transaction/list\nThese requests are helper functions, designed to be used for front-end form building.
\n - GET /vendor/countries\n - GET /vendor/countries/{countryID}/regions\nThis request returns a list of all cards a user has linked to their account. The internal reference numbers for each card can be found here, which allows a specific card to be accessed at a later time.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowcount: the total number of cards a user has linked to their accountdata: an array of objects that hold the card informationcard: an object that contains information specific to the cardcreated: the date this card was added to the system, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00number: the number found on the actual card itselfpin: the personal identification number linked to this cardstatus (see Appendix): an object that contains information about the current status of the cardtype: an internal reference number that indicates the type of the current cardupdated: the last date this card was updated in the system, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00created: the date this card was added to the profile, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that identifies the cardstatus (see Appendix): an object that contains information about the current status of the cardupdated: the last date this card was updated with this profile, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user: an object that contains information about the user, usually emptynext_page_url, previous_page_url: direct urls linking the user to the next and previous pages of resultspage, page_size, total_pages: integers denoting the page number, page size, and the total number of pages{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyThis request adds a new card to a user's account. Once added, a \"user_card\" object is created that links this card with this user. Referencing this object gives us access to both the card and the user, which is important for future requests.
\nuser (integer): the internal reference number specific to the user logged into this sessionnumber (integer): the card number of the card being addedpin (string): the pin associated with this card, required for all /card paths, optional for all /card3rdparty pathscard: an object that holds information about the card addedid: an internal reference number specific to the card addednumber: the card number on the cardcreated: the date this card was added to the account, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that links the card and user, is used to reference this card laterstatus (see Appendix): an object that contains information about the current status of the cardupdated: the last date this card was updated with this profile, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user: an object that contains information about the user this card is being added toemail_address: the user's email addressfirst_name: the user's first nameid: the internal reference number specific to this userlast_name: the user's last name{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyReferencing the link between a user and a specific card, this request updates a given card as lost by changing its status to \"inactive\".
\nuser_card(3rdparty) (integer): the internal reference number that refers to the lost card as it is linked with the user's accountThe response will always be empty, however a status code of 200 OK indicates the card was successfully updated as lost.
\n","urlObject":{"path":["user","card-3rdparty","lost"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"90e178b4-bbd7-4eaa-8542-116299340216","name":"user_card_lost","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\n\t\"user_card\": 1817014\n}"},"url":{"raw":"{{endpoint}}/user/card/lost?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card","lost"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Jun 2019 17:47:02 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null},{"id":"d2bf0db4-27e1-4cc6-9b29-6bdde8d11a42","name":"user_card-3rdparty_lost","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card3rdparty\": 502666\n}"},"url":{"raw":"{{endpoint}}/user/card-3rdparty/lost?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card-3rdparty","lost"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Jun 2019 15:36:58 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"076720ae-5c64-4d4b-9d34-7b3549aa3e9f"},{"name":"user_card(-3rdparty)_found","id":"fa8ac290-6431-43a4-bfc3-317edb6e8c6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card\": 1817014\n}"},"url":"{{endpoint}}/user/card(-3rdparty)/found?session_key={{user_session_key}}","description":"Referencing the link between a user and a specific card, this request updates a given card as found by changing its status to \"active\".
\nuser_card(3rdparty) (integer): the internal reference number that refers to the found card as it is linked with the user's accountThe response will always be empty, however a status code of 200 OK indicates the card was successfully updated as found.
\n","urlObject":{"path":["user","card(-3rdparty)","found"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"2570dac7-e48d-41cd-a932-20d903897595","name":"user_card-3rdparty_found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card3rdparty\": 502666\n}"},"url":{"raw":"{{endpoint}}/user/card-3rdparty/found?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card-3rdparty","found"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Jun 2019 15:38:20 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null},{"id":"ad17e427-ba8c-455c-8232-b6f355ebfa1e","name":"user_card_found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card\": 1817014\n}"},"url":{"raw":"{{endpoint}}/user/card/found?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card","found"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Jun 2019 17:47:24 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fa8ac290-6431-43a4-bfc3-317edb6e8c6e"},{"name":"user/card(-3rdparty)","id":"190d042e-7be7-42f0-be86-84c6f2e50547","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card\": 1817015\n}"},"url":"{{endpoint}}/user/card(-3rdparty)?session_key={{user_session_key}}","description":"Referencing the link between a user and a specific card, this request deletes a given card from a user's account.
\nuser_card(3rdparty) (integer): the internal reference number that refers to the card being removed from the user's accountThe response will always be empty, however a status code of 200 OK indicates the card was successfully deleted.
\n","urlObject":{"path":["user","card(-3rdparty)"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"47e47723-7a81-4a27-b9a8-f68d6c944903","name":"user/card","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_card\": 1817014\n\t\n}"},"url":{"raw":"{{endpoint}}/user/card?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Jun 2019 17:53:52 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null},{"id":"f9dad1fc-0207-4829-bfb1-cfbccfff6ef2","name":"user/card-3rdparty","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card3rdparty\": 502666\n}"},"url":{"raw":"{{endpoint}}/user/card-3rdparty?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card-3rdparty"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Jun 2019 15:40:55 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"190d042e-7be7-42f0-be86-84c6f2e50547"}],"id":"a6015fef-b38b-4bb8-8635-7052a444d0ad","description":"Each card carries a unique ID which can be referenced to access this card. Information for all cards that are linked to a user's account is returned.
\n - GET /user/card/list\n - GET /user/card-3rdparty/list\nA user supplies their user id, a card number, and the pin (/card path only) for this card. This information is used to add a new card to the user's account by adding a unique link between this card and this user. The reference number for this link can be used to obtain details about the user and the card.
- POST /user/card/add\n - POST /user/card-3rdparty/add\nIf a card is lost, a user can change their card status to inactive, which means it will no longer be accepted to check in. By updating the card as found, this status can be changed to active, making the card available to be used again.
\n - PUT /user/card/lost\n - PUT /user/card-3rdparty/lost\n - PUT /user/card/found\n - PUT /user/card-3rdparty/found\nA user can remove a card from their account by supplying the reference number specific to the user/card link. After this process, the card stays in our system, meaning another user can now link this card to their account.
\n - DELETE /user/card\n - DELETE /user/card-3rdparty\nThis request returns information about the user's billing profiles. User billing profiles link to a user's credit card through a token facilitated by a payment gateway. Information specific to the card is never stored in our systems, only details about this link.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowcount: indicates the number of billing profiles the user has linked to their accountdata: an array of billing profiles, where each hold information necessary to complete paymentscard: returns the first and last 4 digits of the credit card number linked to this profilecreated: the date this billing profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry: the expiry date found on this card, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that identifies this billing profileis_default: a boolean, true if this billing profile has been set to be the default profilename: user specific card reference, as it was entered in the description when the card was addedpostal_code: the postal or zip code that is associated with the card's billing addresstype: indicates the type of card in a way that is user friendlynext_page_url, previous_page_url: direct urls linking the user to the next and previous pages of resultspage, page_size, total_pages: integers denoting the page number, page size, and the total number of pagesThis request is responsible for creating a new billing profile on a user's account and adding a credit card to this profile. The user must have an active login session and supply a card number, card name, expiry date and security code for the card.
\nname (string): the name of the cardholdernumber (string): the card numberexpiry_month (string): the month this card expires (mm)expiry_year (string): the year this card expires (yyyy)cvv (string): the security code found on the back of this carddescription (string): a description attached to this card for the user's reference, helps distinguish this card from others zip_code (string): the postal or zip code associated with the billing address for this cardcard: returns the first and last 4 digits of the credit card number linked to this profilecreated: the date this billing profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry: the expiry date found on this card, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that identifies this billing profilename: user specific card reference, as it was entered in the description when the card was addedtype: indicates the type of card in a way that is user friendlyThis request marks a specific billing profile as the default billing profile to be used. This means that the card linked to this profile will be automatically charged as the payment method on an order, unless specified otherwise.
\nuser_billingProfile_id (integer): the internal reference number that refers to the billing profile that is to be marked as defaultThe response is always empty, however a status code of 200 OK indicates this action was successful.
\n","urlObject":{"path":["user","billing-profile","default"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"7895a8f8-ec22-49b1-b7d7-db4a1ce832c0","name":"user_billingProfile_mark_default","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_billingProfile_id\": 69206\n}"},"url":{"raw":"{{endpoint}}/user/billing-profile/default?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","billing-profile","default"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Jun 2019 12:20:20 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"43761c12-084c-4b93-adf6-62a050e51037"},{"name":"user_billing_profile_delete","id":"32242f64-f586-459b-ad14-8570e777227a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_billingprofile\": 69206\n}"},"url":"{{endpoint}}/user/billing-profile?session_key={{user_session_key}}","description":"This request deletes a billing profile from a user's account. A billing profile cannot be edited, so this request may also be used as a step of \"editing\" such a profile. The profile is deleted, then the user_billingProfile_add can be used to re-add this card with the new information.
\nuser_billingprofile (integer): the internal reference number that refers to the billing profile that is to be deletedThe response in always empty, however a status code of 200 OK indicates successful deletion.
\n","urlObject":{"path":["user","billing-profile"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"ba5dc677-deb1-442f-809e-3a19bdfbf148","name":"user_billing_profile_delete","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_billingprofile\": 69206\n}"},"url":{"raw":"{{endpoint}}/user/billing-profile?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","billing-profile"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Jun 2019 15:57:22 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"32242f64-f586-459b-ad14-8570e777227a"},{"name":"user_reload_charge","id":"de19366e-c7ee-4381-943b-14e4944d780c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_billingprofile\": 69206,\n \"amount\": 15\n}"},"url":"{{endpoint}}/user/billing-profile/reload?session_key={{user_session_key}}","description":"This request is called when a user attempts to reload their account. Once a billing profile and amount are supplied, this amount is charged to the billing profile and is loaded onto the user's account in the form of quickpay currency. Sometimes, the 3rd party service \"3D Secure\" will require that the user authorize their card with them. This service is designed to be an extra layer of security which protects both vendors and users from fraud. The user will be redirected to the url that is returned in the response for this request, where they must authenticate their card with the 3rd party. When this occurs, the transaction_status will have a status of pending, until the user satisfies the 3D secure authorization.
user_billingprofile(integer): the internal reference number that refers to the billing profile that is being used to reload the user's accountamount (float): the amount that is to be charged to this billing profile and loaded onto the user's accountredirect_url: the url that redirects to the 3rd party authentication page, only necessary when authentication of the card is requiredtransaction: an object that holds information about the reload transaction that just occurredid: an internal reference number that is unique to each transactionamount: the amount that was charged from this billing profile and loaded to this accounttransaction_type: an object that holds information about the type of transaction that just occuredid: an internal reference number that indicates the type of transaction that occuredname: indicates the type of transaction in a way that is more user friendlytransaction_status: an object that holds information about the transaction's current statusid: an internal reference number for the current status of the transactionname: indicates the transaction status in a way that is more user friendlydate: the date this transaction occurred, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00This request determines if a user has successfully authenticated their card with the 3rd party service \"3D Secure\". The current login session and the reference number for the transaction being accessed are supplied, and the status of authentication is returned.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowtransaction(string): passed in using query parameters, the internal reference number for the transaction for which the status is being checkedstatus (see Appendix): indicates the status of authentication with 3D SecureThe possible values for status and what they mean:
- canceled: the user cancelled the authorization, or the authorization request timed-out and was cancelled by 3D Secure\n - consumed: the authorization was successful and the reload charge went through to the user's account\n - failed: the user entered wrong information and the authorization failed\n - pending: the system is waiting for the user to attempt authenticating their account\nThis request returns a list of images available with this vendor to be included in the egift email.
\nvendor (integer): passed in using the url directly, the internal reference number for the vendor with which an egift is being sentname: identifies the image in a way that is user friendlyurl: a direct url to the imagetags: an array of strings, where each is a keyword that allows this image to be found with a searchThis request allows users to transmit funds to another person. To send an egift as a guest, the buyer must supply their name and email, the name and email of the recipient, and their payment card details, as well as the amount that is being gifted. For a registered user, their active login session id can be supplied, and the reference number of the billing profile they would like to use to pay for the egift can be entered instead of complete card details. The egift arrives to the recipient in an email, which directs them to a page that allows them to log in or register with this vendor in order to accept the gift.
\namount (float): the amount that is being charged to the buyer and that is being gifted to a recipientbuyer (see \"user object\" in Appendix): an object that holds the buyer's informationrecipient (see \"user object\" in Appendix): an object that holds the recipient's informationmessage (string): a message from the buyer to the recipientbilling (see billing 1 and billing 2 in Appendix): an object that holds the buyer's billing informationimage_url (string): the direct url for the image that is to be sent with this egift, if desireduser_egift_id: an internal reference number unique to each egiftreceipt: an object that holds information about the receipt for this transactionreceipt_id: an internal reference number for this receiptreceipt_date: the date this receipt was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00subtotal: the amount that is being sent in this egift, the same as amount in the requestreceiptType: an object that contains information about the type of this receiptreceiptType_id: an internal reference number that indicates the type of receiptname: indicates the type of receipt in a way that is more user friendlyreceiptStatus: an object that contains information about the status of this receiptreceiptStatus_id: an internal reference number that indicates the status of this receiptname: indicates the status of this receipt in a way that is more user friendlystatus (see Appendix): an object that contains information about the current status of the receiptrecipient_email: the email of the recipient of this egiftbuyer_email: the email of the sender of this egiftamount: the amount that is being charged to the sender's account and loaded to the recipient's accountrelease_date: the date this egift was released to be accepted by the recipientstatus (see Appendix): an object that contains information about the current status of the egift{\n \"name\": \"Grace Duncan\", \n \"email\": \"grace@spoonity.com\"\n }\nname (string): the user's nameemail (string): the user's emailUsed when the buyer has not given a specific billing profile, no session identifier is necessary.
\n{\n \"name\": \"Test Card\",\n \"number\": \"4242424242424242\",\n \"expiry\":{\n \"month\": \"06\",\n \"year\": \"19\"\n },\n \"cvv\": \"123\",\n \"zip_code\": \"k1n1k2\"\n }\nname (string): the name of the card holdernumber (string): the card numberexpiry (object): an object that contains information about the expiry date for this cardmonth (string): the month this card expires (mm)year (string): the year this card expires (yy)cvv (string): the security code found on the back of this cardzip_code (string): the postal or zip code for the billing address associated with this cardUsed when the buyer specifies a billing profile to be charged. An active login session for this buyer is necessary, and is passed in using the query parameters.
\n{\n \"id\": 69206\n }\nid (integer): the reference number for the billing profile that is to be accessed\n\nNote: to see examples for both types of billing objects, toggle between the two options at the top of the example request.
\n
{\n \"status_id\": 1,\n \"name\": \"Active\"\n }\nstatus_id: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyThis request returns the current settings for the user's automatic reload configuration. This information can also be found using the user_profile_read request in the \"Profile\" workflow, however that request returns more information than may be desired, and takes slightly longer to do so. If the billing profile is \"null\", automatic reload is turned of, regardless of the values for the reload amount and threshold.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowanonymous: a boolean, always set to falsebilling_profile: the internal reference number for the billing profile set up for automatic reload, \"null\" means auto-reload is offcreated: the date this user was linked to this vendor, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number for this link between the user and the vendor the user is logged intoreload_amount: how much the user would like to add to their account during an automatic reload, must be greater than 0reload_threshold: the point at which the user would like their account to automatically reloadupdated: the last date this user/vendor link was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00This request updates the user's automatic reload settings, by enabling.disabling the reload feature or by updating the amount and/or threshold values. To turn auto-reload on, the user must supply the id of a valid billing profile, specifiy the amount to reload each time, and indicate the point they would like the account to reload. When \"on\", if the user's quickpay balance goes below the indicated threshold, auto-reload removes the specified amount from the billing profile and adds it to the user's quickpay balance. To turn auto-reload off, the user-billingprofile must be set to null.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowamount: how much the user would like to add to their account during an automatic reload, must be greater than 0threshold: the point at which the user's would like their account to automatically reloaduser_billingprofile: the user's billing profile to be used with automatic reload, \"null\" turns auto-reload offbilling_profile: an object that contains information about the billing profile selecte for automatic reload
card: returns the first and last 4 digits of the credit card number linked to this profilecreated: the date this billing profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry: the expiry date found on this card, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that identifies this billing profiletype: indicates the type of card in a way that is user friendlycreated: indicates the date auto-reload was turned on, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
id: an internal reference number for the auto-reload activation
reload_amount: the amount that is to be charged to this billing profile on each automatic reload
reload_threshold: the point at which the user has specified to trigger automatic reload
All billing profiles linked to a user's accuont are returned. Spoonity does not store credit card information directly, the billing profiles instead make use of a token faciliated by a payment gateway to reference this information.
\n - GET /user/billing-profile/list\nUsing these requests, a user can add a new billing profile to their account, or delete a billing profile from their account. Users can also update a billing profile to \"default\", meaning it will be the profile that is automatically charged as the payment method on a given order.
\n - POST /user/billing-profile/add\n - POST /user/billing-profile/default\n - DELETE /user/billing-profile\nThese are the requests related to automatically reloading a user's quickpay balance, and are invoked by the user to do so. This process removes a specified amount from a user's billing profile and adds it to their account in quickpay currency. If the 3rd party \"3D Secure\" requires authentication from the user, it is necessary to check on the status of this authentication before proceeding to the reload.
\n - POST /user/billing-profile/reload\n - GET /user/billing-profile/reload/status\nThese requests allow users to transmit funds from one person to another. Some vendors have specific images to be included in the egift email, which can be found using the first request. Users can send egifts without logging in, but must supply full payment information. If a user is already logged in, their session id and a specified billing profile can be used instead of entering full payment information. The egift arrives to the recipient via email, which directs them to a page that allows them to log in or register with this vendor.
\n - GET /vendor/{{vendor}}/egift/images\n - POST /vendor/{{vendor}}/egift\nA user can turn automatic reload on or off, or simply update the current reload settings. The current settings can be determined using the GET request. To turn automatic reload off, the billing profile must be set to null, and the values for amount and threshold can be ignored. To turn automatic reload on, there must be a valid billing profile entered, an amount greater than 0, and a threshold.
\n - GET /user/reload/settings \n - PUT /user/reload/settings\nThis request allows customers to register and create an onscreen session themselves.
\nOne of the two following parameters is necessary for registration:
\nphone_number (see Appendix): an object that contains information about the user's phone numberemail (string): the email the user would like to register withpos_session: an object that holds information about the current point of sale session that has been created with this request, this object contains:id: an internal reference number for this current sessionhash: the hash value associated with this current order sessiondate_created: the time this session was created, listed as a Unix time stamp in seconds from 1970-01-01 00:00:00date_updated: the last time this session was updated, listed as a Unix time stamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that holds information about the current status of the ordervendor: an object that contains information about the vendor this order has been created throughid: an internal reference number for this vendorpoint_of_sale: an object that holds information about this current point of salepointOfSale_id: an internal reference number which indicates the type of point of salename: indicates the type of point of sale in a way that is more user friendlymodules: an object which contains information about the modules used for this orderdata: an array of objects where each object holds information about a module used, each object contains:id: an internal reference number indicating the current module in usename: indicates the current module in use in a way that is more user friendlyapi_key: used for a small subset of point of sale integration, can likely be ignoredworkstation_identifer: string identifier for the key used in point of sale integration, can likely be ignored{\n \"number\": \"1234567890\",\n \"code\": \"1\"\n }\nnumber (string): the user's phone numbercode (string): the country code for the country the phone number is registered toThis request is used to register an endpoint for Firebase push notifications. This is done by providing a Firebase registration token to this request. This token must be generated using the Firebase SDK.
\nMore details about setting up a Firebase account or project can be found at https://spoonity.atlassian.net/servicedesk/customer/portal/3/article/1407778891?src=278858068.
\nMore details about initializing the Firebase SDK can be found at https://spoonity.atlassian.net/servicedesk/customer/portal/3/article/1408106553?src=-966849765.
\nsession_key (string): passed in using query parameters, must match the dashboard session identifier key created for a dashboard userdevice (string): the Firebase registration token for this device, must be generated using the Firebase SDKuser_vendor_device_id: an internal reference number for the device as it is linked to the useruser_vendor: an object containing information about the currenct user as they are linked to the current vendoruser_vendor_id: an internal reference number that indicates the current user as they are linked to this vendorarn: the registration token provided in the request bodydate_created: holds the time this device was linked as a Unix timestamp in seconds from 1970-01-01 00:00:00date_updated: holds the time this device was last updated as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that holds information about the current status{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly\n\nProvider = Spoonity
\nClient/application = third party that is integrating with Spoonity OAuth services
\n
client_id: an identification code that is unique to this applicationclient_secret: a secure “passcode” that is known only to the application and to the authorization server, used to verify the application’s identity\n\nNOTE:
\nclient_idandclient_secretessentially act as a username and password for the application
the user is routed to Spoonity’s OAuth authorization page, at https://accounts.spoonity.com/oauth/signin
\ncertain information must be included in this route as query parameters:
\nclient_id: the identification string for this applicationredirect_uri: the registered URI that is the desired endpoint for the authentication processresponse_type: indicates the type of authorization that is expected by the application’s server, initializes the authorization flows associated with this valueresponse_type=token, initializes the Implicit flow
response_type=code, initializes the Authorization Code flow
grant_type: indicates the grant type of the current request, always “code” in this flowclient_id: the identification string for this applicationclient_secret: the secret “passcode” that identifies this applicationcode: the authorization code that was received in the query string after being redirected back to the applicationredirect_uri: must match the redirect URI that was provided in the original linkThis request retrieves the privacy policy content set by a vendor.
\nvendor (integer): passed in using query parameters, the internal reference ID of the vendor who's content is being retrievedtitle: the title of the privacy policycontent: the content of the privacy policyLorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam vestibulum arcu vitae urna rutrum eleifend. Vivamus varius pretium gravida. Nunc sit amet felis sem. Sed commodo nisi ligula, et hendrerit ante fermentum ut. Praesent sed erat in nisl efficitur tristique. Nam at urna a enim iaculis semper. Phasellus erat felis, pretium eget eleifend id, bibendum a magna. In sit amet hendrerit magna. Sed vel sapien sodales, rhoncus urna non, bibendum felis. Suspendisse eu lacus tellus. Suspendisse potenti. Vestibulum id nisi eu lectus accumsan dapibus sit amet id sem.
\\nMauris lobortis porta risus, sollicitudin scelerisque dui accumsan sit amet. Mauris at augue non nulla luctus hendrerit et in sapien. Mauris sit amet mauris orci. Nam laoreet magna at enim molestie dictum. Mauris est orci, luctus euismod egestas ut, scelerisque nec sapien. Integer a ex eu velit hendrerit faucibus ac sit amet elit. Proin eget libero at elit blandit auctor laoreet non nisl. Phasellus purus magna, posuere a nisi ac, lobortis euismod libero. Mauris augue velit, ornare sed tortor eget, consequat bibendum ligula. Ut non vehicula orci, vel aliquam sapien. Vestibulum tempor libero nulla, sit amet vulputate dui viverra a. Duis ultrices augue sit amet arcu mollis, ut scelerisque lectus euismod. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut auctor nisl ante, non ultricies metus molestie ut. Aliquam a leo consequat, volutpat velit vitae, cursus nisl.
\\nNullam malesuada eros eu purus elementum, nec fringilla nisi congue. Maecenas placerat ligula feugiat magna porta, quis molestie tellus tempus. Nulla ac odio tempus, vulputate lacus nec, porttitor diam. Integer aliquam, ligula a facilisis auctor, nunc lacus blandit nisi, nec vehicula massa dui eu est. Quisque sollicitudin eget tortor non feugiat. Cras scelerisque sapien vel urna maximus ultrices a vitae lacus. Quisque a sem diam. Praesent scelerisque, magna eget faucibus varius, nunc metus commodo nibh, tempor semper mi tortor vel diam. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
\",\n \"version\": null\n}"}],"_postman_id":"668020ee-b5b4-4732-b2a1-84576f7f3bff"},{"name":"terms_of_service","id":"5d0d0500-f40b-4188-aad5-ee0ac2695482","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/vendor/content/terms-of-service?vendor={{vendor}}","description":"This request retrieves the terms of service content set by a vendor.
\nvendor (integer): passed in using query parameters, the internal reference ID of the vendor who's content is being retrievedtitle: the title of the terms of servicecontent: the content of the terms of serviceLorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam vestibulum arcu vitae urna rutrum eleifend. Vivamus varius pretium gravida. Nunc sit amet felis sem. Sed commodo nisi ligula, et hendrerit ante fermentum ut. Praesent sed erat in nisl efficitur tristique. Nam at urna a enim iaculis semper. Phasellus erat felis, pretium eget eleifend id, bibendum a magna. In sit amet hendrerit magna. Sed vel sapien sodales, rhoncus urna non, bibendum felis. Suspendisse eu lacus tellus. Suspendisse potenti. Vestibulum id nisi eu lectus accumsan dapibus sit amet id sem.
\\nMauris lobortis porta risus, sollicitudin scelerisque dui accumsan sit amet. Mauris at augue non nulla luctus hendrerit et in sapien. Mauris sit amet mauris orci. Nam laoreet magna at enim molestie dictum. Mauris est orci, luctus euismod egestas ut, scelerisque nec sapien. Integer a ex eu velit hendrerit faucibus ac sit amet elit. Proin eget libero at elit blandit auctor laoreet non nisl. Phasellus purus magna, posuere a nisi ac, lobortis euismod libero. Mauris augue velit, ornare sed tortor eget, consequat bibendum ligula. Ut non vehicula orci, vel aliquam sapien. Vestibulum tempor libero nulla, sit amet vulputate dui viverra a. Duis ultrices augue sit amet arcu mollis, ut scelerisque lectus euismod. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut auctor nisl ante, non ultricies metus molestie ut. Aliquam a leo consequat, volutpat velit vitae, cursus nisl.
\\nNullam malesuada eros eu purus elementum, nec fringilla nisi congue. Maecenas placerat ligula feugiat magna porta, quis molestie tellus tempus. Nulla ac odio tempus, vulputate lacus nec, porttitor diam. Integer aliquam, ligula a facilisis auctor, nunc lacus blandit nisi, nec vehicula massa dui eu est. Quisque sollicitudin eget tortor non feugiat. Cras scelerisque sapien vel urna maximus ultrices a vitae lacus. Quisque a sem diam. Praesent scelerisque, magna eget faucibus varius, nunc metus commodo nibh, tempor semper mi tortor vel diam. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
\",\n \"version\": null\n}"}],"_postman_id":"5d0d0500-f40b-4188-aad5-ee0ac2695482"}],"id":"8254ee02-1854-44cd-8522-c0b735f45de5","_postman_id":"8254ee02-1854-44cd-8522-c0b735f45de5","description":""},{"name":"onscreen","item":[{"name":"onscreen_create","id":"18aee7a4-a6ea-4e3d-8074-dc1be097f9e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"card_number\": \"brandin@spoonity.com\"\n}"},"url":"{{endpoint}}/onscreen?api_key={{apikey}}","description":"This is the call that occurs when a customer is in store engaging with a cashier, and provides information that can be used to identify this customer. The identification of the customer is crucial for the next step in the workflow, and is made accessible to that request via the hash value that is returned in the response of this request.
\ncard_number (string): part of the user's identification which allows us to access details about account holder, can be given as:pos_session: an object that holds information about the current point of sale session that has been created with this request, this object contains:id: an internal reference number for this current sessionhash: the hash value associated with this current order sessiondate_created: holds the time this session was created as a Unix timestamp in seconds from 1970-01-01 00:00:00date_updated: holds the last time this session was updated as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that holds information about the current status of the ordervendor: an object that contains information about the vendor this order has been created throughid: an internal reference number for this vendorpoint_of_sale: an object that holds information about this current point of saleid: an internal reference number which indicates the type of point of salename: indicates the type of point of sale in a way that is more user friendlystatus (see Appendix): an object that holds information about the current status of the point of salemodules: an object which contains information about the modules used for this orderdata: an array of objects where each object holds information about a module used, each object contains:id: an internal reference number indicating the current module in usename: indicates the current module in use in a way that is more user friendlyapi_key: used for a small subset of point of sale integration, can likely be ignoredworkstation_identifer: string identifier for the key used in point of sale integration, can likely be ignored{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyThis request is used to access a list of users who are already checked in, which can be done by the customer through a mobile application or manually by a cashier. The request returns an array of sessions of checked in users, each with a unique point of sale hash key which is referenced whenever that session's user information is required.
\nThe only information required for this request is the api_key given in the query parameters.
Each object in the array has information for:
\npos_session: an object that holds information regarding this specific point of sale session, this object contains: id: the internal reference number that is related to the current point of sale session hash: the hash value associated with this current order sessionvendor: an object that contains information about the current vendor, this object includes:vendor_id: an internal reference number unique to each vendorname: indicates the vendor in a way that is more user friendlyuser: an object that holds information about the user checking into this session, this object contains:user_id: an internal reference number unique to each userfirst_name: the user's first namelast_name: the user's last nameemail_address: the user's email addresstable_number: the table number the user has checked in toredemptions (see Appendix): an array of all redemptions a user desires to use this session, which was specified through the mobile applicationpayments (see Appendix): an array of all payment options a user desires to use this session, which was specified through the mobile applicationdate_created: the date this session was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00date_updated: the last date this session was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that contains information about the current status of the point of sale session{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly\"redemptions\": [{\n \"vendor_perk_redemption_id\": 121,\n \"name\": \"Free Coffee\",\n \"currency\": {\n \"currency_id\": 45,\n \"name\": \"Coffee Point\"\n },\n \"cost\": 10\n }]\nvendor_perk_redemption_id: internal reference number that is unique to each vendor perk redemptionname: indicates the vendor perk redemption in a way that is more user friendlycurrency (see Appendix): an object that contains information about the type of currency being usedcost: indicates the price of 1 unit of this redemption\"payments\": [{\n \"method\": \"quickpay\",\n \"amount\": 20.00\n }]\nmethod: the payment method the customer has specified to use, can be:\n\nNote: if the method provided is billing_profile, another parameter is necessary:\n
\nuser_billingProfile_id: the internal reference number associated with the user's billing profile
amount: the amount that is being authorized to be paid out of this account{\n \"currency_id\": 45,\n \"name\": \"Coffee Point\"\n },\ncurrency_id: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendlyThis request uses the point of sale session hash key that was generated with the onscreen_create request to access the identification information that was provided by the user. This identification information allows us to retrieve the user's account, which gives us information like their first and last names, their birthday, and a list of rewards this user is currently eligible for. The user's loyalty and quick pay balances are also retrieved at this point, which are necessary in the step for the authorization of payments.
\npos_session_hash (string): passed in using query parameters, must match the hash found in the response of the onscreen_create requestpos_session: an object that holds information regarding this specific point of sale session, this object contains:
pos_session_id: the internal reference number that is related to the current point of sale session hash: the hash value associated with this current order session status (see Appendix): an object that holds information about the current status of the orderOnly one of the following three arguments will have a value that is not null at any given time. The argument that gets a non-null value depends on how the user checked in.
\ncard: if the user checked in with a card, that information is held here and the other two arguments are nullcard_third_party: if the user checked in with a third party card, that information is held here and the other two arguments are nulltoken: if the user used any other method to check in, that information is held here and the other two arguments are nulluser: an object that holds all information related to the user in the current session
email_address: the user's email addressdefault_billing_profile: an identification number associated with the user's default billing profilebirthdate: the user's date of birth, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00address: the user's addressphone_number: the user's phone numbercedula: the user's cedula, if applicableclover_id: the user's clover idpassport_number: the user's passport numberfirst_name: the user's first namelast_name: the user's last nameis_employee: true if the user is an employee with this vendor, false if the user is notid: the internal reference number for the userbirthday: the user's birthdaylast_visit: the date the user last visited this vendor, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00favourite_items: an array that contains information about the user's favourite items
reload: an object that contains information regarding the user's auto-reload configuration
amount: how much a user has indicated to reload automatically with automatic reloadthreshold: the point at which the user's account will automatically reloadbilling_profile: the user's billing profile that is selected for automatic reloadfavorite: deprecated
last_visit: deprecated
loyalty_balance: an object that contains information about the loyalty balance associated with this user, this object contains
data: an array of objects where each contains a different piece of information about a user's loyalty balanceamount: the number of units of a certain currency that is associated with the user's accountcurrency (see Appendix): an object that contains information about the type of currency being usedexpiring (see Appendix): an object that holds information about when this balance will expirerules: an object that holds information about the rules for this current point of sale, each object contains:
earning: an object which contains information about the rules related to earning loyalty points, this object contains:data: an array that holds all necessary information for the loyalty point earning process, each object contains earning information for one perkid: an internal reference number for this earning rulecurrency (see Appendix): an object that contains information about the type of currency being usedname: indicates the type of current in a way that is more user friendlyperk_type: an object that holds information about the type of perk offered that is earning pointsid: an internal reference number that is unique to each type of perkname: indicates the type of perk in a way that is more user friendlyround_policy: an object that holds information about how points will be rounded during this point of saleid: an internal reference number that indicates the type of rounding that is to occurname: indicates the type of rounding in a way that is more user friendlyaward_amount: the ratio of points awarded when the earning rule is invokedmax_award_amount: the maximum number of points that can be earned in a single instance of a point of salestart_date: the date this perk begins, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00end_date: the date this perk ends, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that contains information about the current status of the earning rulespending: an object that holds information about the rules related to spending loyalty points, each object contains:data: an array that contains all information necessary to the loyalty point spending process, each object in the array contains spending information for one reward:template (see Appendix): the style type for how the perk should be displayedid: the internal reference number unique to each rewardcurrency (see Appendix): an object that contains information about the type of currency being usedname: indicates the type of reward in a way that is more user friendlydescription: a description of what the reward entailssummary: a brief overview of what the promotion is and what points will be removedcost: how many points this promotion costs to redeemstart_date: the date this promotion begins, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00end_date: the date this promotion ends, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00available: how many perks of this type the user is able to redeem with their current loyalty balanceprogress: the number of points the user has towards qualifying for a perk of this typecatalog: an object that holds information regarding the item that is attached to this redemptionid: an internal reference number that is unique to each itemidentifier: the reference number for this item that is supplied by the point of salename: indicates the item in a way that is more user friendlytype: in spending rules, perks are exclusively type discountid: an internal reference number that is unique to type discountname: indicates the type of the current spending rule in a way that is more user friendlytier: an object that holds information about the prestige level of the usercount: total number of tiers this vendor hascurrent: an object that holds information about the current tiername: indicates the current tier in a way that is more user friendlysince: the date this tier was achieved, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00type: an object that contains the specific information for this tierid: an internal reference number unique to each type of tiername: indicates the type of this tier in a way that is more user friendlyranking: the rank of this tiernext: an object that contains information about the next tier level to be attainedname: indicates the name of the next tier in a way that is more user friendlyamount: the number of criteria required to achieve this tierprogress: the number of criteria the user currently has towards reaching the next tiersummary: a summary of the perks offered at the next tierdescription: a description of the next tierall: an object that contains information about all tiers possible at this vendorvendor_tier_changed: the last date the user's tier changed, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00tier_immunity_days: a configuration value from the vendor, indicates how long a user has on this tier before being downgradeddays_remaining: the time left between now and when the user will be downgradeddata: an array of objects that each hold information about one tier, one object for each tier holds the same information found in nextquick_pay_balance: an object that holds information about the quick pay balance a user has linked to their account
amount: the total units of currency availablecurrency (see Appendix): an object that contains information about the type of currency being usedexpiring (see Appendix): an object that holds information about when this balance will expire{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly{\n \"id\": 191,\n \"name\": \"Canadian Dollar\",\n \"code\": \"CAD\"\n }\nid: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendlycode: the ISO 4217 code associated with this type of currency, a null value here indicates a loyalty currency{\n \"data\": []\n }\ndata: an array of objects that give information about the date of expiry of this loyalty balance (as a Unix timestamp in seconds from 1970-01-01 00:00:00), and the quantity of the balance that expires on this date{\n \"id\": 2,\n \"name\": \"POINT\"\n }\nid: an internal reference number that is unique to each templatename: indicates the template style in a way that is more user friendlyThis request uses the session hash key that was generated in the first call of this workflow to close the current session so the next user can check in. In most cases, the Spoonity API automatically closes the most recent session once an order is complete, however this request can also be called manually.
\npos_session_hash: the hash value for the session that is being closedThe response will always be empty, however a status of \"200 OK\" indicates successful closure.
\n","urlObject":{"path":["onscreen"],"host":["{{endpoint}}"],"query":[{"key":"api_key","value":"{{apikey}}"}],"variable":[]}},"response":[{"id":"1d465262-d4f1-4cd9-954a-caac5bd49bfe","name":"onscreen_close","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"pos_session_hash\": \"9c18e2d6bc8e9771a96b248061f2a5ff\"\n\n}"},"url":{"raw":"{{endpoint}}/onscreen?api_key={{apikey}}","host":["{{endpoint}}"],"path":["onscreen"],"query":[{"key":"api_key","value":"{{apikey}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 May 2019 15:39:22 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) PHP/7.1.15 OpenSSL/1.0.2k-fips"},{"key":"X-Powered-By","value":"PHP/7.1.15"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d5851807-2be1-408e-b9a0-b1e71bfdb138"},{"name":"onscreen_register","id":"d8fe17ec-cde5-49de-841e-1b2f4ed8182d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"grace@spoonity.com\"\n}"},"url":"{{endpoint}}/onscreen/register?api_key={{apikey}}","description":"This request allows customers to register and create an onscreen session themselves.
\nOne of the two following parameters is necessary for registration:
\nphone_number (see Appendix): an object that contains information about the user's phone numberemail (string): the email the user would like to register withpos_session: an object that holds information about the current point of sale session that has been created with this request, this object contains:id: an internal reference number for this current sessionhash: the hash value associated with this current order sessiondate_created: the time this session was created, listed as a Unix time stamp in seconds from 1970-01-01 00:00:00date_updated: the last time this session was updated, listed as a Unix time stamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that holds information about the current status of the ordervendor: an object that contains information about the vendor this order has been created throughid: an internal reference number for this vendorpoint_of_sale: an object that holds information about this current point of salepointOfSale_id: an internal reference number which indicates the type of point of salename: indicates the type of point of sale in a way that is more user friendlymodules: an object which contains information about the modules used for this orderdata: an array of objects where each object holds information about a module used, each object contains:id: an internal reference number indicating the current module in usename: indicates the current module in use in a way that is more user friendlyapi_key: used for a small subset of point of sale integration, can likely be ignoredworkstation_identifer: string identifier for the key used in point of sale integration, can likely be ignored{\n \"number\": \"1234567890\",\n \"code\": \"1\"\n }\nnumber (string): the user's phone numbercode (string): the country code for the country the phone number is registered toThis request returns a list of a specified user's most recent transactions, ordered from newest to oldest. Only transactions that involved spending or earning quickpay or loyalty currencies are returned here. This request allows changes to this user's account balances to be seen.
\nuser (integer): passed in using query parameters, the user_id for the desired customercount: the total number of transactions returned with this responsenext_page_url, previous_page_url: direct urls linking the user to the next and previous pages of resultspage, page_size, total_pages: integers denoting the page number, page size, and the total number of pagesdata: an array of objects that each hold information about previous transactions, ordered newest to oldestrating: an object that holds information about the rating of this transactioncomment: the feedback from the customer regarding this transactionvalue: the value of the rating on a scale of 0-100, where 0 is bad, 100 is good, and -1 indicates there was no rating provided for this transactionwindow: an integer that indicates the number of hours available to leave a rating, in reference to the time of the ordertip: an object that contains information about the tip on this transactionamount: the value of the tip given on this transactionwindow: an integer that indicates the number of hours available to leave a tip, in reference to the time of the orderid: the internal reference number for this specific transactiondate: the date this transaction was completed, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00total: usually the same as subtotal, safe to ignore as does not affect the calculation of pointsaddress: the address of the store where this transaction occurredname: the name of the store where this transaction occurredquickpay: an object that holds information regarding the changes in quickpay balance for this transactionused: indicates the amount of quickpay that was redeemed on this orderloaded: indicates the amount of quickpay that was added on this orderbalance: the current balance of this users quickpay, as of this transactionitems: an array of objects where each object holds information about an item on this ordertype: an internal reference number that indicates the catalog type of item (eg. discount/product/etc)name: indicates the item in a way that is user friendly, as assigned by the vendorquantity: how many of these items were orderedprice: the price of one of these itemsid: an internal reference number specific to this itemloyalty: an array of objects that each contain information about a change in the loyalty balance for this transactiontransaction_detail_id: an internal reference number specific to this change of loyalty balancecurrency (see Appendix): an object that contains information about the type of currency being usedamount: how many loyalty points were added to or removed from the user's accounttaxes: usually an empty array, can safely be ignoredreceipts: holds the receipt information for this transactiondate: the date this transaction occurred, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00subtotal: indicates the subtotal of the overall orderid: an internal reference number for this ordernumber: the receipt number as assigned to this transaction by the point of salecashier: the cashier that completed this transactionworkstation: the identifier for the workstation used for this transaction, as supplied by the point of salereward: an array of objects that each contain information regarding the rewards redeemed or earned on this transactionexpired: indicates if this reward is expiredexpiry_date: the date this reward expires, a Unix timestamp in seconds from 1970-01-01 00:00:00name: indicates the current reward in a way that is more user friendlyid: an internal reference number that indicates the current rewardspent: the number of loyalty points redeemed with this rewardearned: the number of loyalty points earned with this rewardbalance: the current loyalty balance after this reward was appliedperks: an array indicating the earning rules that were applied to this transactionredemptions: an array indicating the spending rules that were applied to this transactionstatus: indicates the status of the transaction in a way that is user friendly{\n \"id\": 961,\n \"name\": \"Points\",\n }\nid: an internal reference number that indicates the type of currencyname: indicates the type of currency in a way that is more user friendlyThis request returns information about the user's billing profiles. User billing profiles link to a user's credit card through a token facilitated by a payment gateway. Information specific to the card is never stored in our systems, only details about this link.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowcount: indicates the number of billing profiles the user has linked to their accountdata: an array of billing profiles, where each hold information necessary to complete paymentscard: returns the first and last 4 digits of the credit card number linked to this profilecreated: the date this billing profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry: the expiry date found on this card, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that identifies this billing profileis_default: a boolean, true if this billing profile has been set to be the default profilename: user specific card reference, as it was entered in the description when the card was addedpostal_code: the postal or zip code that is associated with the card's billing addresstype: indicates the type of card in a way that is user friendlynext_page_url, previous_page_url: direct urls linking the user to the next and previous pages of resultspage, page_size, total_pages: integers denoting the page number, page size, and the total number of pagesThis request is responsible for creating a new billing profile on a user's account and adding a credit card to this profile. The user must have an active login session and supply a card number, card name, expiry date and security code for the card.
\nname (string): the name of the cardholdernumber (string): the card numberexpiry_month (string): the month this card expires (mm)expiry_year (string): the year this card expires (yyyy)cvv (string): the security code found on the back of this carddescription (string): a description attached to this card for the user's reference, helps distinguish this card from others zip_code (string): the postal or zip code associated with the billing address for this cardcard: returns the first and last 4 digits of the credit card number linked to this profilecreated: the date this billing profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry: the expiry date found on this card, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that identifies this billing profilename: user specific card reference, as it was entered in the description when the card was addedtype: indicates the type of card in a way that is user friendlyThis request marks a specific billing profile as the default billing profile to be used. This means that the card linked to this profile will be automatically charged as the payment method on an order, unless specified otherwise.
\nuser_billingProfile_id (integer): the internal reference number that refers to the billing profile that is to be marked as defaultThe response is always empty, however a status code of 200 OK indicates this action was successful.
\n","urlObject":{"path":["user","billing-profile","default"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"c9cfa23a-d430-4226-b9dc-26dd199a073e","name":"user_billingProfile_mark_default","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_billingProfile_id\": 69206\n}"},"url":{"raw":"{{endpoint}}/user/billing-profile/default?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","billing-profile","default"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Jun 2019 12:20:20 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"569f730e-4b83-4473-8b6f-f51bae7a1c40"},{"name":"user_billing_profile_delete","id":"404ecfc4-38a4-4245-b4b2-456f9ae0f493","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_billingprofile\": 69206\n}"},"url":"{{endpoint}}/user/billing-profile?session_key={{user_session_key}}","description":"This request deletes a billing profile from a user's account. A billing profile cannot be edited, so this request may also be used as a step of \"editing\" such a profile. The profile is deleted, then the user_billingProfile_add can be used to re-add this card with the new information.
\nuser_billingprofile (integer): the internal reference number that refers to the billing profile that is to be deletedThe response in always empty, however a status code of 200 OK indicates successful deletion.
\n","urlObject":{"path":["user","billing-profile"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"7d4bb803-cbce-486a-b171-f7ad39039f07","name":"user_billing_profile_delete","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_billingprofile\": 69206\n}"},"url":{"raw":"{{endpoint}}/user/billing-profile?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","billing-profile"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Jun 2019 15:57:22 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"404ecfc4-38a4-4245-b4b2-456f9ae0f493"},{"name":"user_reload_settings_read","id":"9f33e312-4c58-40bf-9442-edb12f89cc48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/reload/settings?session_key={{user_session_key}}","description":"This request returns the current settings for the user's automatic reload configuration. This information can also be found using the user_profile_read request in the \"Profile\" workflow, however that request returns more information than may be desired, and takes slightly longer to do so. If the billing profile is \"null\", automatic reload is turned of, regardless of the values for the reload amount and threshold.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowanonymous: a boolean, always set to falsebilling_profile: the internal reference number for the billing profile set up for automatic reload, \"null\" means auto-reload is offcreated: the date this user was linked to this vendor, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number for this link between the user and the vendor the user is logged intoreload_amount: how much the user would like to add to their account during an automatic reload, must be greater than 0reload_threshold: the point at which the user would like their account to automatically reloadupdated: the last date this user/vendor link was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00This request updates the user's automatic reload settings, by enabling.disabling the reload feature or by updating the amount and/or threshold values. To turn auto-reload on, the user must supply the id of a valid billing profile, specifiy the amount to reload each time, and indicate the point they would like the account to reload. When \"on\", if the user's quickpay balance goes below the indicated threshold, auto-reload removes the specified amount from the billing profile and adds it to the user's quickpay balance. To turn auto-reload off, the user-billingprofile must be set to null.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowamount: how much the user would like to add to their account during an automatic reload, must be greater than 0threshold: the point at which the user's would like their account to automatically reloaduser_billingprofile: the user's billing profile to be used with automatic reload, \"null\" turns auto-reload offbilling_profile: an object that contains information about the billing profile selecte for automatic reload
card: returns the first and last 4 digits of the credit card number linked to this profilecreated: the date this billing profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry: the expiry date found on this card, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that identifies this billing profiletype: indicates the type of card in a way that is user friendlycreated: indicates the date auto-reload was turned on, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
id: an internal reference number for the auto-reload activation
reload_amount: the amount that is to be charged to this billing profile on each automatic reload
reload_threshold: the point at which the user has specified to trigger automatic reload
This request is called when a user attempts to reload their account. Once a billing profile and amount are supplied, this amount is charged to the billing profile and is loaded onto the user's account in the form of quickpay currency. Sometimes, the 3rd party service \"3D Secure\" will require that the user authorize their card with them. This service is designed to be an extra layer of security which protects both vendors and users from fraud. The user will be redirected to the url that is returned in the response for this request, where they must authenticate their card with the 3rd party. When this occurs, the transaction_status will have a status of pending, until the user satisfies the 3D secure authorization.
user_billingprofile(integer): the internal reference number that refers to the billing profile that is being used to reload the user's accountamount (float): the amount that is to be charged to this billing profile and loaded onto the user's accountredirect_url: the url that redirects to the 3rd party authentication page, only necessary when authentication of the card is requiredtransaction: an object that holds information about the reload transaction that just occurredid: an internal reference number that is unique to each transactionamount: the amount that was charged from this billing profile and loaded to this accounttransaction_type: an object that holds information about the type of transaction that just occuredid: an internal reference number that indicates the type of transaction that occuredname: indicates the type of transaction in a way that is more user friendlytransaction_status: an object that holds information about the transaction's current statusid: an internal reference number for the current status of the transactionname: indicates the transaction status in a way that is more user friendlydate: the date this transaction occurred, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00This request determines if a user has successfully authenticated their card with the 3rd party service \"3D Secure\". The current login session and the reference number for the transaction being accessed are supplied, and the status of authentication is returned.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowtransaction(string): passed in using query parameters, the internal reference number for the transaction for which the status is being checkedstatus (see Appendix): indicates the status of authentication with 3D SecureThe possible values for status and what they mean:
- canceled: the user cancelled the authorization, or the authorization request timed-out and was cancelled by 3D Secure\n - consumed: the authorization was successful and the reload charge went through to the user's account\n - failed: the user entered wrong information and the authorization failed\n - pending: the system is waiting for the user to attempt authenticating their account\n\nThis request returns a list of all cards a user has linked to their account. The internal reference numbers for each card can be found here, which allows a specific card to be accessed at a later time.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowcount: the total number of cards a user has linked to their accountdata: an array of objects that hold the card informationcard: an object that contains information specific to the cardcreated: the date this card was added to the system, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00number: the number found on the actual card itselfpin: the personal identification number linked to this cardstatus (see Appendix): an object that contains information about the current status of the cardtype: an internal reference number that indicates the type of the current cardupdated: the last date this card was updated in the system, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00created: the date this card was added to the profile, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that identifies the cardstatus (see Appendix): an object that contains information about the current status of the cardupdated: the last date this card was updated with this profile, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user: an object that contains information about the user, usually emptynext_page_url, previous_page_url: direct urls linking the user to the next and previous pages of resultspage, page_size, total_pages: integers denoting the page number, page size, and the total number of pages{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyThis request adds a new card to a user's account. Once added, a \"user_card\" object is created that links this card with this user. Referencing this object gives us access to both the card and the user, which is important for future requests.
\nuser (integer): the internal reference number specific to the user logged into this sessionnumber (integer): the card number of the card being addedpin (string): the pin associated with this card, required for all /card paths, optional for all /card3rdparty pathscard: an object that holds information about the card addedid: an internal reference number specific to the card addednumber: the card number on the cardcreated: the date this card was added to the account, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that links the card and user, is used to reference this card laterstatus (see Appendix): an object that contains information about the current status of the cardupdated: the last date this card was updated with this profile, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user: an object that contains information about the user this card is being added toemail_address: the user's email addressfirst_name: the user's first nameid: the internal reference number specific to this userlast_name: the user's last name{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyReferencing the link between a user and a specific card, this request updates a given card as lost by changing its status to \"inactive\".
\nuser_card(3rdparty) (integer): the internal reference number that refers to the lost card as it is linked with the user's accountThe response will always be empty, however a status code of 200 OK indicates the card was successfully updated as lost.
\n","urlObject":{"path":["user","card-3rdparty","lost"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"46f8558a-5b38-40d8-b1a7-caa5703adece","name":"user_card_lost","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\n\t\"user_card\": 1817014\n}"},"url":{"raw":"{{endpoint}}/user/card/lost?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card","lost"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Jun 2019 17:47:02 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null},{"id":"6d4a966f-d9a4-4e2f-8331-a7e6fc9bf852","name":"user_card-3rdparty_lost","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card3rdparty\": 502666\n}"},"url":{"raw":"{{endpoint}}/user/card-3rdparty/lost?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card-3rdparty","lost"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Jun 2019 15:36:58 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"78d6850f-f28f-4b3a-8c2f-6f2ce9b3d959"},{"name":"user_card(-3rdparty)_found","id":"406bdce6-538a-4ca7-a701-be3405875a83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card\": 1817014\n}"},"url":"{{endpoint}}/user/card(-3rdparty)/found?session_key={{user_session_key}}","description":"Referencing the link between a user and a specific card, this request updates a given card as found by changing its status to \"active\".
\nuser_card(3rdparty) (integer): the internal reference number that refers to the found card as it is linked with the user's accountThe response will always be empty, however a status code of 200 OK indicates the card was successfully updated as found.
\n","urlObject":{"path":["user","card(-3rdparty)","found"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"040aba17-18e1-473c-9076-f68fc0ac7cec","name":"user_card-3rdparty_found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card3rdparty\": 502666\n}"},"url":{"raw":"{{endpoint}}/user/card-3rdparty/found?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card-3rdparty","found"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Jun 2019 15:38:20 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null},{"id":"a523ff43-0bd2-463f-9ec3-a438f2ba21c4","name":"user_card_found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card\": 1817014\n}"},"url":{"raw":"{{endpoint}}/user/card/found?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card","found"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Jun 2019 17:47:24 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"406bdce6-538a-4ca7-a701-be3405875a83"},{"name":"user/card(-3rdparty)","id":"97b76f3a-4115-4556-b265-d5391e67d240","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card\": 1817015\n}"},"url":"{{endpoint}}/user/card(-3rdparty)?session_key={{user_session_key}}","description":"Referencing the link between a user and a specific card, this request deletes a given card from a user's account.
\nuser_card(3rdparty) (integer): the internal reference number that refers to the card being removed from the user's accountThe response will always be empty, however a status code of 200 OK indicates the card was successfully deleted.
\n","urlObject":{"path":["user","card(-3rdparty)"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"239de9ec-a9fc-444b-a04d-528c28611936","name":"user/card","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_card\": 1817014\n\t\n}"},"url":{"raw":"{{endpoint}}/user/card?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Jun 2019 17:53:52 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null},{"id":"23eeb970-bbfb-45e1-b9b3-6ae820bcdfa4","name":"user/card-3rdparty","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_card3rdparty\": 502666\n}"},"url":{"raw":"{{endpoint}}/user/card-3rdparty?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","card-3rdparty"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Jun 2019 15:40:55 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"97b76f3a-4115-4556-b265-d5391e67d240"}],"id":"1b43105d-fb76-48dc-823d-c2d608ffc456","event":[{"listen":"prerequest","script":{"id":"b69bf13a-0382-4202-b84a-ce4e2ff88b5b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a396def4-6ae8-47d6-8ac3-cf3ddeb2e3ae","type":"text/javascript","exec":[""]}}],"_postman_id":"1b43105d-fb76-48dc-823d-c2d608ffc456","description":""},{"name":"rewards/balances","item":[{"name":"user_quickpay_balance","id":"946cc86b-46d3-4cd4-abff-6e5335a4421f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/quick-pay/balance?session_key={{user_session_key}}","description":"This request is used to check the user's quick pay balance on their account.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowamount: the quantity of quickpay balance the user has on their accountcurrency (see Appendix): an object that contains information about the type of currency being used{\n \"code\": \"CAD\"\n \"id\": 191,\n \"name\": \"Canadian Dollar\",\n }\ncode: the ISO 4217 code associated with this type of currency, a null value indicates a loyalty currencyid: the internal reference number for the type of currencyname: indicates the type of currency in a way that is more user friendlyThis request is used to check all balances on a user's account, both quickpay and loyalty balances are returned.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowAn array of two objects where one is quick pay and one is points. Each contains:
\ncurrency: an object that contains information about what currency is being usedcurrency_id: an internal reference number that indicates what currency is in usename: indicates the currency in a way that is more user friendlycurrencyType: an object that holds information about the type of currency being usedcurrencyType_id: an internal reference number that indicates the type of currency being usedname: indicates the type of currency being used in a way that is more user friendlystatus (see Appendix): an object that contains information about the current status of this currencybalance: indicates the amount of this currency that is on this accountexpiring: an array of objects that give information about the date of expiry of this loyalty balance (as a Unix timestamp in seconds from 1970-01-01 00:00:00), and the quantity of the balance that expires on this date{\n \"status_id\": 1,\n \"name\": \"Active\"\n }\nstatus_id: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyThis request returns a list of rewards this user is eligible for with this vendor, as well as information about the user's tier.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowbalances: an array of objects that hold information about the balances of each currency on this user's accountid: an internal reference number that indicates which currency is being referencedname: indicates the currency being referenced in a way that is more user friendlybalance: shows the balance of this currency on this user's accountcount: indicates the number of rewards this user has availabledata: an array of objects that hold information about each vendor reward this user has availablecatalog: an object that contains information about how this reward is invokedid: an internal reference number that refers to the line_item (see order_process (loyalty) in \"Placing an order\") that invokes this redemption rulename: indicates the line_item that invokes this redemption rule in a way that is more user friendlysummary: a brief overview of what the reward is and what points will be removedtemplate (see Appendix): the style type for how the perk should be displayedtype: an object that holds information about the type of reward being offeredid: an internal reference number that indicates the type of reward being offeredname: indicates the type of reward being offered in a way that is more user friendlyid: an internal reference number unique to each rewardcurrency (see Appendix): an object that contains information about the type of currency being usedname: indicates the reward in a way that is more user friendlydescription: a description of what the reward entailscost: the amounot of points this reward requires to be redeemedavailable: how many of these rewards the user is able to redeem with their current loyalty balanceprogress: the number of points the user has towards qualifying for a reward of this typeexpiring (see Appendix): an object that holds information about when this reward will expirenext_page_url, previous_page_url: direct urls linking the user to the next and previous pages of resultspage, page_size, total_pages: integers denoting the page number, page size, and the total number of pagestier: an object that holds information about the prestige level of the usercount: total number of tiers this vendor hascurrent: an object that holds information about the user's current tierdescription: a description of the current tierid: an internal reference number that indicates the user's current tiersummary: a summary of the rewards offered at the current tiername: indicates the name of the current tier in a way that is more user friendlysince: the date this tier was achieved, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00next: an object that contains information about the next tier level to be attainedid: an internal reference number for the next tiername: indicates the name of the next tier in a way that is more user friendlyprogress: the number of criteria the user currently has towards reaching the next tieramount: the number of criteria required to achieve this tiersummary: a summary of the perks offered at the next tierdescription: a description of the next tierall: an object that contains information about all possible tiers with this vendorvendor_tier_changed: the last date the user's tier changed, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00 tier_immunity_days: a configuration value from the vendor, indicates how long a user has on this tier before being downgradeddays_remaining: the time left between now and when the user will be downgradeddata: an array of objects that each hold information about one tier, one object for each tier holds the same information found in next{\n \"id\": 2,\n \"name\": \"POINT\"\n }\nid: an internal reference number that is unique to each templatename: indicates the template style in a way that is more user friendly{\n \"id\": 191,\n \"name\": \"Canadian Dollar\",\n }\nid: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendly{\n \"data\": []\n }\ndata: an array of objects that give information about the date of expiry of this loyalty balance (as a Unix timestamp in seconds from 1970-01-01 00:00:00), and the quantity of the balance that expires on this dateThis request is not necessary to the workflow as it only gives information about the vendor and their perks, but can be loosely included in the \"checking in\" step. All the active perks at this vendor are listed, regardless of if the user qualifies or not.
\nThe only information required for this request is the api_key given in the query parameters.
The response appears as an array of objects where each object contains information about an individual perk. Each object contains:
\nvendor_perk_redemption_id: an internal reference number that is unique to each perkvendor: an object that holds information about the current vendor, this object contains:vendor_id: an internal reference number that is unique to each vendorname: indicates the current vendor in a way that is more user friendlystatus (see Appendix): an object that holds information about the current status of this vendortype: an object that contains information about the type of perk that is being offered, this object contains:perkRedemptionType_id: an internal reference number that is unique to each type of perkname: indicates the type of perk in a way that is more user friendlycurrency (see Appendix): an object that contains information about the type of currency being usedtemplate (see Appendix): the style type for how the perk should be displayedname: indicates the name of the perk in a way that is more user friendlysummary: a brief overview of what the perk is and what points will be removeddescription: a description of what the perk entailscost: how many points this perk costs to redeemstart_date: the date this perk begins, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00end_date: the date this perk ends, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00date_created: the date this perk was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00date_updated: the last date this perk was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that holds information about the current status of this list{\n \"status_id\": 1,\n \"name\": \"Active\"\n }\nstatus_id: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly{\n \"id\": 191,\n \"name\": \"Canadian Dollar\"\n }\nid: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendly{\n \"id\": 2,\n \"name\": \"POINT\"\n }\nid: an internal reference number that is unique to each templatename: indicates the template style in a way that is more user friendlyThis request returns a list of images available with this vendor to be included in the egift email.
\nvendor (integer): passed in using the url directly, the internal reference number for the vendor with which an egift is being sentname: identifies the image in a way that is user friendlyurl: a direct url to the imagetags: an array of strings, where each is a keyword that allows this image to be found with a searchThis request allows users to transmit funds to another person. To send an egift as a guest, the buyer must supply their name and email, the name and email of the recipient, and their payment card details, as well as the amount that is being gifted. For a registered user, their active login session id can be supplied, and the reference number of the billing profile they would like to use to pay for the egift can be entered instead of complete card details. The egift arrives to the recipient in an email, which directs them to a page that allows them to log in or register with this vendor in order to accept the gift.
\namount (float): the amount that is being charged to the buyer and that is being gifted to a recipientbuyer (see \"user object\" in Appendix): an object that holds the buyer's informationrecipient (see \"user object\" in Appendix): an object that holds the recipient's informationmessage (string): a message from the buyer to the recipientbilling (see billing 1 and billing 2 in Appendix): an object that holds the buyer's billing informationimage_url (string): the direct url for the image that is to be sent with this egift, if desireduser_egift_id: an internal reference number unique to each egiftreceipt: an object that holds information about the receipt for this transactionreceipt_id: an internal reference number for this receiptreceipt_date: the date this receipt was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00subtotal: the amount that is being sent in this egift, the same as amount in the requestreceiptType: an object that contains information about the type of this receiptreceiptType_id: an internal reference number that indicates the type of receiptname: indicates the type of receipt in a way that is more user friendlyreceiptStatus: an object that contains information about the status of this receiptreceiptStatus_id: an internal reference number that indicates the status of this receiptname: indicates the status of this receipt in a way that is more user friendlystatus (see Appendix): an object that contains information about the current status of the receiptrecipient_email: the email of the recipient of this egiftbuyer_email: the email of the sender of this egiftamount: the amount that is being charged to the sender's account and loaded to the recipient's accountrelease_date: the date this egift was released to be accepted by the recipientstatus (see Appendix): an object that contains information about the current status of the egift{\n \"name\": \"Grace Duncan\", \n \"email\": \"grace@spoonity.com\"\n }\nname (string): the user's nameemail (string): the user's emailUsed when the buyer has not given a specific billing profile, no session identifier is necessary.
\n{\n \"name\": \"Test Card\",\n \"number\": \"4242424242424242\",\n \"expiry\":{\n \"month\": \"06\",\n \"year\": \"19\"\n },\n \"cvv\": \"123\",\n \"zip_code\": \"k1n1k2\"\n }\nname (string): the name of the card holdernumber (string): the card numberexpiry (object): an object that contains information about the expiry date for this cardmonth (string): the month this card expires (mm)year (string): the year this card expires (yy)cvv (string): the security code found on the back of this cardzip_code (string): the postal or zip code for the billing address associated with this cardUsed when the buyer specifies a billing profile to be charged. An active login session for this buyer is necessary, and is passed in using the query parameters.
\n{\n \"id\": 69206\n }\nid (integer): the reference number for the billing profile that is to be accessed\n\nNote: to see examples for both types of billing objects, toggle between the two options at the top of the example request.
\n
{\n \"status_id\": 1,\n \"name\": \"Active\"\n }\nstatus_id: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyThis request is used if the user authorizes payment for the current order with their quick pay balance. The quick pay balance is retrieved by using a specific means of identification, and is used here to determine if the user has sufficient funds to spend the desired amount in quick pay, or if the user has sufficient funds to load their quick pay balance.
\ncard_number (string): part of the user's identification which allows us to access details about the account holder, can be given as:
receipt_number (string): the invoice id from the point of sale. If it matches a receipt_number generated previously from a loyalty request, then the two requests will be linked in Spoonity.
till (integer): only used for tracking and information purposes, and is not relevant to the order itself
amount (float): indicates how much is being added to or removed from the user's account, a positive value here adds this amount and a negative value removes this amount
date (integer): the date this authorization is occurring, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00 in the customer's local time
cashier (object, see Appendix below): used for tracking and information purposes, not relevant to the order itself
success: indicates if the request was successfully authorized by Spoonity or notreference_number: the identification number that Spoonity uses to keep track of this order internallyreceipt_data: holds information about the process that just occurred and information about the user indicated in the request. Contains:lines: shows the process was successful in a way that is user friendlyuser: contains more in depth information about the user making the order:id: an internal reference number that is unique to each usercard_number: the same card_number that was provided in the requestbalances: an array that contains information about the different balances a user has on their profile. Each object in balances contains:id: an identification number for the type of currencycurrency: indicates the type of currency in a way that is more user friendlybalance: the amount of this currency that is availabletype: indicates the category of payment being used{\n \"id\": \"1\",\n \"name\": \"Tony\"\n }\n\nid (string): an identification number assigned to a cashiername (string): the name of the cashierThis request is used if the user authorizes payment for the current order with their loyalty balance. The loyalty balance is retrieved by using a specific means of identification, and is used here to determine if the user has sufficient funds to use the desired amount in loyalty points.
\ncard_number (string): part of the user's identification which allows us to access details about the account holder, can be given as:amount (float): the amount that is being paid in dollars by the usersuccess: indicates if the request was successfully authorized by Spoonity or notamount: indicates the amount in dollars that was removed from the user's account, amount of points actually removed varies based on individual loyalty systemstransaction_id: a reference number that only supplements the order, this number only references the payment itselfHere, details about the items in the order, discounts on these items, and discounts on the overall order are sent to our system to complete the sale. If the user is spending points on this order, this request removes them from the user's account. If there are any points to be gained on this order, this request will also add those points to the user's account. The appearance of the response of this request may change based on the structure of the loyalty system with each vendor. Once this order is complete, often the DEL onscreen_close request is called immediately to close the session.
\n\n\nNote: to see examples for both spending points and earning points, toggle between the two options at the top of the example request.
\n
card_number (string): part of the user's identification which allows us to access details about the account holder, can be given as:
till (integer): only used for tracking and information purposes, and is not relevant to the order itself
receipt_number (string): the invoice id from the point of sale
subtotal (float): the only value that is used to calculate points earned from this order
taxes (array): holds information about what taxes are on the order, not relevant to the calculation of points
total (float): the amount the customer actually pays, not relevant to the calculation of points
payment_method (string): how the customer pays for the order
date (integer): the date this authorization is occurring, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00 in the customer's local time
cashier (object, see Appendix below): used for tracking and information purposes, not relevant to the order itself
line_items (array of line_item objects, see Appendix below): holds information about each item in the order
discount (array of discount objects, see Appendix): holds objects that have information about discounts on the overall order
reference_number: the identification number that Spoonity uses to keep track of this order internallysuccess: indicates if the request was successfully authorized by Spoonity or notreceipt_data: holds information about the process that just occurred and information about the user indicated in the request, contains:lines: shows the process was successful in a way that is user friendlypoints: contains information about the points that are being redeemed or earned, each object in this array containscurrency (see Appendix): an object that holds information about the type of currency being usedamount: indicates the quantity of the points that are being removed or addedexpiryDate: indicates the date that these points will expire, as a Unix timestamp in seconds from 1970-01-01 00:00:00user: contains more in depth information about the user making the order:id: an internal reference number that is unique to each usercard_number: the same card_number that was provided in the requestbalances: an array that contains information about the different balances a user has on their profileid: an internal reference number for the type of currencycurrency: indicates the type of currency in a way that is more user friendlybalance: the amount of this currency that is availabletype: indicates the category of payment being used{\n \"id\": \"1\",\n \"name\": \"Tony\"\n }\n\nid (string): an identification number assigned to a cashiername (string): the name of the cashier{\n \"id\": \"coffee\",\n \"name\": \"Regular Drip\",\n \"categories\": [],\n \"discounts\": [],\n \"price\": 2,\n \"quantity\": 1,\n \"modifiers\": []\n }\n\nid (string): an identification number that is unique to this itemname (string): identifies the item in a way that is more user friendlycategories (array): not relevant to the order, can be ignoreddiscounts (array of discount objects, see Appendix): holds objects that have information about a discount specific to this line itemprice (float): indicates the price of 1 unit of this item, must be a positive valuequantity (integer): indicates how many units of this item are being purchased on this ordermodifiers (array of line_items, see Appendix): contains information about items which modify the current item being ordered{\n \"id\": \"clover_discount\",\n \"name\": \"Free item\",\n \"amount\": 2\n }\n\nid (string): an internal reference that is unique to this itemname (string): identifies the item in a way that is more user friendlyamount (float): indicates how much this discount is worth in dollars, must be a positive value{\n \"id\": \"coffee\",\n \"name\": \"Regular Drip\",\n \"categories\": [],\n \"discounts\": [],\n \"price\": 2,\n \"quantity\": 1,\n \"modifiers\": []\n }\n\nid (string): an identification number that is unique to this itemname (string): identifies the item in a way that is more user friendlycategories (array): not relevant to the order, can be ignoreddiscounts (array of discount objects, see Appendix): holds objects that have information about a unique discountprice (float): indicates the price of 1 unit of this itemquantity (integer): indicates how many units of this item are being purchased on this ordermodifiers: each modifier has another array of modifiers, making it possible for modifiers to be nested infinitely{\n \"id\": 191,\n \"name\": \"Canadian Dollar\"\n }\n\nid: an identification number for the type of currencyname: indicates the type of currency in a way that is more user friendlyThis request is used to void an order if necessary. Orders can only be voided in order from the most recent sale. To void a sale that was not the most recent, the more recent orders must be voided until the desired order to void is reached, that order must be voided, then the more recent orders must be re-applied in the sequence they occurred.
\nreceipt (integer): identifies which order is meant to be voided, matches the reference_number that is found in the response of the order_process (loyalty) requestvoided: true if this order was successfully voidedThis request determines if the given email is linked with any account at Spoonity.
\nemail (string): passed in using query parameters, the email that is being attempted to be foundvendor (integer): passed in using the query parameters, the vendor with which the email is being checkedexists: a boolean, true if this email exists, false otherwisevendor (see Appendix): an object that contains information about the vendor this email was first registered with{\n \"id\": 1,\n \"name\": \"Spoonity\"\n}\n\nid: the internal reference number used to identify the vendorname: identifies the vendor in a way that is more user friendlyThis request determines if a cedula is linked to any account at Spoonity.
\ncedula (string): passed in using query parameters, the cedula that is being searchedvendor (integer): passed in using the query parameters, the vendor with which the cedula is being checkedexists: a boolean, true if the cedula exists in our systemvalid: a boolean, true if the cedula provided is valid in the vendor's country of residencevendor: an object that contains information about the vendor this cedula was first registered with{\n \"id\": 1,\n \"name\": \"Spoonity\"\n}\nid: the internal reference number used to identify the vendorname: identifies the vendor in a way that is more user friendlyThis request determines if a mobile phone number is linked with any account at Spoonity.
\nmobile (string): passed in using query parameters, the desired mobile number to be foundvendor (integer): passed in using query parameters, the id of the vendor with which the mobile number is being checkedavailable: a boolean, true if this is a valid phone number that is available to be registered, false otherwiseThis request is responsible for creating a profile for a new user. This sets up an account with basic user information such as first and last names, the user's email address, and the user's preferred language.
\nRequired parameters:
\nfirst_name (string): the first name of the user that is registeringlast_name (string): the last name of the user that is registeringanonymous (boolean): always set to falseemail_address (string): the email the user wants linked to their accountpassword (string): the password the user will use to access their accountterms (boolean): always set to truevendor (integer): the internal reference number associated with the specific vendor with which the user is registeringOptional parameters:
\nbirthdate (integer): the user's date of birth as a Unix timestamp in seconds from 1970-01-01 00:00:00language (integer, see Appendix): an internal reference number that indicates the user's preferred languagecedula (string): the cedula of the user that is registering, only needed in South Americacontact_consent (integer, see Appendix): an internal reference number that represents the user's consent to being contactedid: an internal reference number associated with this userfirst_name: the first name the user registered withlast_name: the last name this user registered withemail_address: the email address this user registered withbirthdate: the user's date of birth if it was included as a Unix timestamp in seconds from 1970-01-01 00:00:00date_created: the date this account was created as a Unix timestamp in seconds from 1970-01-01 00:00:00date_updated: the date this account was last updated as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see Appendix): an object that holds information about the current status of the user{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the status of the username: indicates the user's current status in a way that is more user friendlyPossible values and their corresponding meanings for this integer:
\n1 = en (English)\n2 = fr (French)\n3 = es (Spanish)\n4 = ar (Arabic)\nPossible values and their corresponding meanings for this integer:
\n0 = no contact was enabled\n1 = only email contact was enabled\n2 = only SMS contact was enabled\n3 = both email and SMS contact was enabled\nThis request authenticates a user's credentials and creates a login session. Here, information about the user as it applies to this vendor is returned. The session identifier value is crucial to accessing this current login session at any given time.
\nemail_address (string): the email with which the user registered their accountpassword (string): the password with which the user registered their accountvendor (integer): the internal reference number for the vendor with which the user is attempting to log infirst_login: a boolean value indicating if this is the user's first login to this vendor with this accountonline_order_token: unique to this login session, allows a specific third party to access this same login session, in most cases this is safe to ignorevendor_user: in this case will always be null, safe to ignoresession_identifier: a key unique to this current login sessionuser_vendor: an object that contains information about the user that is specific to this vendor, this object contains:language (see Appendix): an object that holds information about the language the user selected with this vendorvendor: an object that holds information about the current vendoranonymous: a boolean set with account registration, always falsereload_amount: how much a user has indicated to reload automatically with automatic reloadreload_threshold: the point at which the user's account will automatically reloadcontact_consent (see Appendix): an integer indicating if the user has allowed the vendor to contact themcreated: the date the account was created with this vendor, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00billing_profile: the internal reference number of the billing profile used for automatic reloadtier (see Appendix): an object that contains information about the prestige level of the user with the current vendortier_since: the date this user reached this tier, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user (see Appendix): an object that contains information about the current user{\n \"code\": \"en\",\n \"id\": 1,\n \"name\": \"English\"\n}\ncode: the two letter ISO 639-1 code associated with this languageid: the internal reference number Spoonity uses to identify this languagename: identifies the language in a way that is more user friendly{\n \"id\": 1,\n \"name\": \"Spoonity\"\n}\nid: the internal reference number used to identify the vendorname: identifies the vendor in a way that is more user friendlyPossible values and their corresponding meanings for this integer:
\n0 = no contact was enabled\n1 = only email contact was enabled\n2 = only SMS contact was enabled\n3 = both email and SMS contact was enabled\n{\n \"id\": 12,\n \"name\": \"Default\",\n \"summary\": \"\",\n \"description\": \"\"\n}\nid: an internal reference number unique to each tiername: identifies the tier in a way that is more user friendlysummary: a summary of the perks offered at this tierdescription: a description of the current tier{\n \"id\": \"582846\",\n \"first_name\": \"brandin\",\n \"last_name\": \"chiu\"\n}\nid: an internal reference number unique to each userfirst_name: the user's first namelast_name: the user's last nameThis request activates a user's account. The user must have an active login session, and must have received an activation token in an email or SMS. This token is necessary to activate the account.
\ntoken (string): passed in using query parameters, the value that was sent to the user via emailsession_identifier (string): passed in using query parameters, must match the session identifier key found in the response of the user_authenticate requestThe response will always be empty, however a status code of 200 OK indicates successful activation.
\n","urlObject":{"path":["user","activate"],"host":["{{endpoint}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"session_identifier","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"093c8f19-0e1a-4172-8da3-7001408b3cdd","name":"user_activate_create","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/user/activate?token={{token}}&session_identifier={{user_session_key}}","host":["{{endpoint}}"],"path":["user","activate"],"query":[{"key":"token","value":"{{token}}"},{"key":"session_identifier","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 May 2019 15:13:40 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3ad6714b-9c4f-4d7f-b9a7-99b619833579"},{"name":"user_send_activation_email_read","id":"01184dab-69c4-4fe5-b085-f9846c6daf4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/activate/email?session_identifier={{user_session_key}}","description":"This request sends an email to the user currently logged into the given session, this email contains the information necessary to verify that email address.
\nsession_identifier (string): passed in through the query parameters, must match the session identifier key created with the user_authenticate requestThe response will always be empty, however a status code of 200 OK will indicate the email was sent successfully.
\n","urlObject":{"path":["user","activate","email"],"host":["{{endpoint}}"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"7a441499-c1c0-4f38-ac1d-58c9e1c995ee","name":"user_send_activation_email_read","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/user/activate/email?session_identifier={{user_session_key}}","host":["{{endpoint}}"],"path":["user","activate","email"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 13:27:42 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"01184dab-69c4-4fe5-b085-f9846c6daf4b"},{"name":"user_send_activation_sms_read","id":"9610f4eb-60c9-4b65-b4bc-54e0cadb9ecc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/activate/sms?session_identifier={{user_session_key}}&phone={{phone}}&country=CA","description":"This request sends an SMS message to the user currently logged into the given session, and contains the information necessary to verify the mobile number on the account. If the user would like to change the mobile number this SMS message is sent to, extra query parameters phone and country must be included.
session_identifier (string): passed in through the query parameters, must match the session identifier key created with the user_authenticate requestphone parameter can be included, allowing the user to change the phone number during SMS validation (in case of error). When this parameter is included, it is also necessary to have:country (string): the two letter ISO 3166-1 code that indicates which country this phone number is registered inThe response will always be empty, however a status code of 200 OK will indicate the SMS message was sent successfully.
\n","urlObject":{"path":["user","activate","sms"],"host":["{{endpoint}}"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"},{"key":"phone","value":"{{phone}}"},{"key":"country","value":"CA"}],"variable":[]}},"response":[{"id":"0e015c3b-7dda-45ec-ab15-a15151d4a86a","name":"user_send_activation_sms_read","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/user/activate/sms?session_identifier={{user_session_key}}","host":["{{endpoint}}"],"path":["user","activate","sms"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"},{"key":"phone","value":"{{phone}}","disabled":true},{"key":"country","value":"CA","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 13:28:38 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null},{"id":"4f263862-c77c-4b44-816d-31a88c8f141b","name":"user_send_activation_sms_read (error)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/user/activate/sms?session_identifier={{user_session_key}}","host":["{{endpoint}}"],"path":["user","activate","sms"],"query":[{"key":"session_identifier","value":"{{user_session_key}}"},{"key":"phone","value":"{{phone}}","disabled":true},{"key":"country","value":"CA","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 14:40:14 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"406"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 0,\n \"reference_id\": null,\n \"more_info\": \"http://api.spoonity.com/doc/#apiMethod\",\n \"errors\": [\n {\n \"reason\": \"exception\",\n \"message\": \"There was an error trying to verify your number, please try again. If the problem persists, please contact support.\"\n }\n ]\n },\n \"object\": \"error\"\n}"}],"_postman_id":"9610f4eb-60c9-4b65-b4bc-54e0cadb9ecc"},{"name":"user_is_validated","id":"4854dba8-a1d8-4834-a2c0-9566a9de4886","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/isValidated?session={{user_session_key}}","description":"This request checks if a user is validated at a specific vendor. The session key gives access to information about which user has activated this session and with what vendor, making it unnecessary to supply any other information.
\nsession (string): passed in using query parameters, must match the session identifier found in the response of the user_authenticate requestisValidated: a boolean, true if the user is validated, false if notphone_number: the phone number associated with this usermethods: an array verification methods that are enabled with this vendor, user must have at least one of these verified in order to be validated status: an object that holds information about the status of validation for this userNo Verification: a boolean, true if the user has had their validation overridden by the vendor and does not have to validate their account, false otherwiseEmail: a boolean, true if the user has validated their account through email, false otherwiseSms: a boolean, true if the user has validated their account through SMS, false otherwiseThis request uses the session identifier key that was generated in the user_authenticate request to log out of the session.
\nsession_key (string): passed in using query parameters, must match the session identifier key that was created with the user_authenticate requestThe response will always be empty, however a status code of 200 OK indicates successful logging out.
\n","urlObject":{"path":["user","logout"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"28906593-3a65-4adc-af76-cc1d595386f7","name":"user_logout","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":{"raw":"{{endpoint}}/user/logout?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["user","logout"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 14:42:22 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"91bbe668-75a7-4669-a6ee-097b6c3fb349"},{"name":"user_password_reset_reset","id":"6767c8b9-ec55-4f5f-97da-d87ef36ee7b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email_address\": \"brandin@spoonity.com\",\n\t\"vendor\": 1\n}"},"url":"{{endpoint}}/user/password-reset/reset","description":"With this request, the user can reset the password linked to their account. This request is used when a user indicates they forgot their password, so the user must only supply an email address to receive the reset information. An email is sent to the given address with a \"token\", which must be sent with the next request to finalize the password reset.
\nemail_address (string): the email address for the account for which the password is being reset vendor (integer): the internal reference number for the vendor with which the user is resetting their passwordThe response will always be empty, however a status 200 OK code indicates the email was sent to the user.
\n","urlObject":{"path":["user","password-reset","reset"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"2ea9ec54-c37a-421e-9290-de4358b6196e","name":"user_password_reset_reset","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email_address\": \"brandin@spoonity.com\",\n\t\"vendor\": 1\n}"},"url":"{{endpoint}}/user/password-reset/reset"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 May 2019 15:39:49 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6767c8b9-ec55-4f5f-97da-d87ef36ee7b4"},{"name":"user_password_reset_apply","id":"3db3f6dd-a7cd-46b7-8ab6-de73cbeb44bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"8ac39a5f61785061a6c4a1c8abe8dd9c\",\n\t\"password\": \"Spoonity1\"\n}"},"url":"{{endpoint}}/user/password-reset/apply","description":"The token sent in the email to the user is used in this request to access the user's account and apply the new password. Requiring this token adds an extra measure of security, as it means the user is authorized to access to the email that is linked to the account being changed. Without this, any user could change the password to any given account for which they know an email address, regardless of authorization to access that email or Spoonity account ownership.
\ntoken (string): the value that was sent to the customer via the email they entered in the previous requestpassword (string): the new password for this user's accountThe response will always be empty, however a status code of 200 OK will indicate that the new password was applied.
\n","urlObject":{"path":["user","password-reset","apply"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"d771bde9-c95b-47f1-9116-5b41e1676d37","name":"user_password_reset_apply","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"8ac39a5f61785061a6c4a1c8abe8dd9c\",\n\t\"password\": \"Spoonity1\"\n\n}"},"url":"{{endpoint}}/user/password-reset/apply"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 May 2019 14:44:03 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, public, s-maxage=0"},{"key":"Expires","value":"Sat, 01 Jan 2000 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3db3f6dd-a7cd-46b7-8ab6-de73cbeb44bd"},{"name":"user_profile_read","id":"d284653a-d0dc-4217-ad14-d51c522573aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/profile?session_key={{user_session_key}}","description":"This request is used to get a user's profile information. The session_identifier that was produced on the user's login is used to fetch general information about the user such as their address, first and last names, push notification settings, contact consent settings, etc. This request will also return any optional information that is linked to the user's account, such as a user's favourite location if this has been specified.
\nsession_key (string): passed in through the query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowanonymous: a boolean, always set to falsebilling_profile (see Appendix): the user's billing profile that is selected for automatic reload, null if this feature is disabledcontact_consent (see Appendix): an internal reference number that represents the user's consent to be contacted by this vendorcreated: the date this user's profile was created with this specific vendor, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00flagged: a boolean, true if this user's account has been flagged for suspicious or fraudulent behaviourid: an internal reference number that links the user's account to this specific vendoris_verified (see Appendix): an object that indicates if the user is verified or not, similar to the response of the user_is_validated request in the \"Registering an account\" workflowlanguage (see Appendix): an internal reference number indicating the language that the user has specified to usemetadata (see Appendix): an array of objects that each store details about information that is surplus to the user's required profile dataonline_order_token: unique to this login session, allows a specific third party to access this same login session, in most cases this is safe to ignorepush_endpoints (see Appendix): unique id that can be used to send the user push notificationsreferral_url: a url that this user can share with a new user to earn points or apply a discount to both accountsreload_amount: how much a user has indicated to reload automatically with automatic reloadreload_threshold: the point at which the user's account will automatically reloadstatus (see Appendix): an object that contains information about the current status of the userupdated: the last date this profile was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user (see Appendix): an object that contains information about the user whose profile is being readvendor: an object that is always returned empty, safe to ignore{\n card: \"4242 xxxx xxxx 4242\",\n created: 1562871344,\n expiry: 1564531200,\n id: \"69235\",\n name: \"nickname\",\n object: \"user_billingprofile\",\n status: {},\n type: \"Visa\",\n updated: 1563299711\n}\n\ncard: the first and last 4 digits of the credit card number linked to this profile
created: the date this billing profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
expiry: the expiry date found on this card, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
id: an internal reference number that identifies this billing profile
name: user specific card reference, as it was entered in the description when the card was added
status: (see Appendix): an object that contains information about the current status of the billing profile
type: indicates the type of card in a way that is user friendly
updated: the last date this billing profile was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00
Possible values and their corresponding meanings for this integer:
\n0 = no contact was enabled\n1 = only email contact was enabled\n2 = only SMS contact was enabled\n3 = both email and SMS contact was enabled\n\n{\n \"status\": true,\n \"methods\": {\n \"No Verification\": false,\n \"Email\": true,\n \"Sms\": true\n }\n\nstatus: a boolean, true if the user is validatedmethods: an object that holds information about the enabled verification methods with this vendor, each object contains:No Verification: a boolean, true if the user has had their validation overridden by the vendor and does not have to validate their account, false otherwiseEmail: a boolean, true if the user has validated their account through email, false otherwiseSms: a boolean, true if the user has validated their account through SMS, false otherwisePossible values and their corresponding meanings for this integer:
\n1 = en (English)\n2 = fr (French)\n3 = es (Spanish)\n4 = ar (Arabic)\n\n{\n \"user_metadata_id\": \"6770055\",\n \"user_metadataField_id\": 7,\n \"field\": \"Address\",\n \"value\": \"123 Smith St\",\n \"validation\": null,\n \"input_type\": null\n }\n\nuser_metadata_id: an internal reference number that is unique to each user metadata objectuser_metadataField_id: an internal reference number that refers to the type of information help by this objectfield: indicates the type of information stored in this object in a way that is more user friendlyvalue: the input for this type of information as it applies to the user{\n \"gcm\": [],\n \"apns\": []\n }\n\ngcm and apns are arrays that hold information for push notifications{\n \"id\": 1,\n \"name\": \"Active\"\n }\n\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly{\n \"object\": \"user\",\n \"id\": 1000454652210,\n \"cid\": null,\n \"facebook_identifier\": null,\n \"email_address\": \"grace@spoonity.com\",\n \"first_name\": \"Grace\",\n \"last_name\": \"Duncan\",\n \"phone_number\": \"11234567890\",\n \"passport_number\": null,\n \"address\": {\n \"address1\": \"123 Smith St\",\n \"address2\": \"\",\n \"city\": \"\",\n \"region\": null,\n \"country\": null,\n \"postal_code\": \"\"\n },\n \"birthdate\": 845856000,\n \"pet\": {\n \"name\": null,\n \"date_of_birth\": null\n },\n \"created\": 1558967253,\n \"updated\": 1559225428,\n \"status\": {}\n }\n\nid: an internal reference number that is unique to each usercid: safe to ignoreemail_address: the user's email addressfirst_name: the user's first namelast_name: the user's last namephone_number: the user's phone numberpassport_number: the user's passport numberaddress (see Appendix): an object that holds information about the user's addressbirthdate: the user's birthdate, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00created: the date the user's profile was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00updated: the last date this user's profile was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00status (see above Appendix entry): an object that contains information about the current status of the user{\n \"address1\": \"123 Smith St\",\n \"address2\": \"\",\n \"city\": \"\",\n \"region\": null,\n \"country\": null,\n \"postal_code\": \"\"\n}\n\naddress1: the first line of the user's addressaddress2: the second line of the user's address, if applicablecity: the user's cityregion: an object that contains information about the user's regionregion_id: an internal reference number unique to each regionname: indicates the region in a way that is more user friendlycountry: an object that holds information about the user's countrycountry_id: an internal reference number unique to each countryname: indicates the country in a way that is more user friendlypostal_code: the user's postal or zip codeThis request is used to update information on a user's account. If only one piece of information is being updated, only that parameter has to be sent with the request. If multiple pieces of information are being updated, multiple parameters can be sent with one request to do this. This request can be used to change things such as a user's password, email, or address.
\nEach of these parameters are optional, it is only necessary to include the parameters that are being updated.
\n\n\nNote: if email or password is being updated,
\ncurrent_password(string) must also be included
address1 (string): the user's updated addresscity (string): the user's updated cityregion (integer): the user's updated region as the internal reference number to this regioncountry (integer): the user's updated country as the internal reference number to this regionpostal_code (string): the user's updated postal or zip codephone_number (object, see Appendix): an object that contains information necessary to update the user's phone numberpassword (string): the user's updated password, must include parameter current_passwordemail_address (string): the user's updated email, must include parameter current_passwordlanguage (integer, see Appendix): the user's updated language preference as the internal reference number for this languagecontact_consent (integer, see Appendix): the user's updated consent preferences as the internal reference number to this preferencefirst_name (string): the user's updated first namelast_name(string): the user's updated last namestatus (object, see Appendix): an object that contains the information necessary to update the user's statusmetadata (object, see Appendix): an object that contains the information necessary to update a metadata valueThe response will always be empty however a status code of 200 OK indicates the profile was updated successfully
\n{\n \"number\": \"1234567890\",\n \"code\": \"1\"\n}\n\nnumber (string): the user's updated phone numbercode (string): the country code associated with this numberPossible values and their corresponding meanings for this integer:
\n1 = en (English)\n2 = fr (French)\n3 = es (Spanish)\n4 = ar (Arabic)\n\nPossible values and their corresponding meanings for this integer:
\n0 = no contact was enabled\n1 = only email contact was enabled\n2 = only SMS contact was enabled\n3 = both email and SMS contact was enabled\n\n{\n \"id\": 1,\n \"name\": \"Active\"\n }\n\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendly{\n \"user_metadata_id\": \"6770055\",\n \"user_metadataField_id\": 7,\n \"field\": \"Address\",\n \"value\": \"123 Smith St\",\n \"validation\": null,\n \"input_type\": null\n }\n\nuser_metadata_id: an internal reference number that is unique to each user metadata objectuser_metadataField_id: an internal reference number that refers to the type of information this object holdsfield: indicates the type of information stored in this object in a way that is more user friendlyvalue: the input for this type of information as it applies to the userThis request returns a unique token and barcode for the user. This barcode can be used to identify the user on check in when placing an order.
\nsession_key (string): passed in through the query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowtoken_type (integer): a static value that is always 2barcode: raw image data that can be used to identify user on check increated: the date this token was created, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry: the date this token will expire, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00id: an internal reference number that is unique to each tokenstatus (see Appendix): an object that contains information about the current status of this tokentoken: holds the same information encoded in the barcode, in string formtype: a reference number for the type of token being returned, always the same so safe to ignoreupdated: the last date this token was updated, listed as a Unix timestamp in seconds from 1970-01-01 00:00:00user: an empty object, safe to ignorevendor: an empty object, safe to ignore{\n \"id\": 1,\n \"name\": \"Active\"\n }\nid: an internal reference number indicating the statusname: indicates the current status in a way that is more user friendlyThis request is called when a user indicates they would like to delete their account. An email is sent to the customer with a code that will allow them to confirm the deletion process.
\nvendor (integer): passed in using the url directly, the internal reference number for the vendor with which that account is being deleteduser (integer): passed in using the url directly, the internal reference number for the user's account that is to be deletedsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowThe response will always be empty, but a status code of 204 No Content indicates an email was successfully sent.
\n","urlObject":{"path":["vendor","{{vendor}}","customers","{{user}}","submit"],"host":["{{endpoint}}"],"query":[{"key":"session_key","value":"{{user_session_key}}"}],"variable":[]}},"response":[{"id":"eec130d5-29e2-4914-bd6e-f33d9f4716b2","name":"user_delete_submit","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{}"},"url":{"raw":"{{endpoint}}/vendor/{{vendor}}/customers/{{user}}/submit?session_key={{user_session_key}}","host":["{{endpoint}}"],"path":["vendor","{{vendor}}","customers","{{user}}","submit"],"query":[{"key":"session_key","value":"{{user_session_key}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Thu, 30 May 2019 17:09:13 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, x-requested-with, API-SESSION, Content-Type, Content-Range, Content-Disposition, Content-Description"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, no-cache, no-store, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e04a2029-b47b-4dde-912d-a81b8ebe04ee"},{"name":"user_delete","id":"545c1348-741f-4664-8cf8-6246f13c1753","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"code\": \"aca0a733c0ba5a8afde59ce6d6f4dbf3\"\n}"},"url":"{{endpoint}}/vendor/{{vendor}}/customers","description":"The code received by the user via their email is sent to our system using this request, along with the vendor with which this account is being deleted. This request is responsible for the actual deletion of the user's account.
\nvendor (integer): passed in using the url directly, the internal reference number for the vendor with which this user's account is being deletedcode (string): the code that the user received via emailThe response returns an empty array, and a status code 200 OK indicates the account was successfully deleted.
\n","urlObject":{"path":["vendor","{{vendor}}","customers"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"59ebe0a0-51cc-42d8-8ad4-259dc7209bc3","name":"user_delete","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"code\": \"aca0a733c0ba5a8afde59ce6d6f4dbf3\"\n}"},"url":"{{endpoint}}/vendor/1/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 May 2019 17:11:21 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, x-requested-with, API-SESSION, Content-Type, Content-Range, Content-Disposition, Content-Description"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, no-cache, no-store, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"2"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"545c1348-741f-4664-8cf8-6246f13c1753"},{"name":"user_message_read","id":"5626e884-eebd-4147-a01c-85ccc7153de0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/message?session_key={{user_session_key}}&user_message={{user_message_id}}","description":"This request returns a specific message as it is linked to a user's account. The user session key that was generated with the user_authenticate request and the reference number for the desired user_message are both required.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowuser_message (integer): passed in using the query parameters, must match the user message id of the desired user message to be vieweduser_message_id: an internal reference number that links the message to this specific useruser_id: an internal reference number unique to each usermessage: an object that contains information about this message, this object contains:message_id: an internal reference number unique to each messagetitle: the title of this messagesubtitle: the subtitle of this messagebanner: a direct url for the banner image in this messagebody: the body of this message publish_date: the time this message was created as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry_date: the time this message will expire as a Unix timestamp in seconds from 1970-01-01 00:00:00read: a boolean indicating if this message has been read by this usertest env content
\\n\\n\",\n \"publish_date\": 1587684453,\n \"expiry_date\": null\n },\n \"read\": false\n}"}],"_postman_id":"5626e884-eebd-4147-a01c-85ccc7153de0"},{"name":"user_message_update","id":"53cda47a-7f1a-4246-a05c-46aac03ba528","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_message\": 3296353,\n \"read\": false,\n \"status_id\": 1\n}"},"url":"{{endpoint}}/user/message?session_key={{user_session_key}}","description":"This request is used to update the details of a specific message linked to a user's account. Specifically, it can be used to delete a message via the status_id, or to mark a message as read by this user.
\nRequired parameters:
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowuser_message (integer): the internal reference number that refers to the desired message as it is linked to the user's accountstatus_id (integer): an internal reference number that indicates the current status of this user messageOptional Parameters:
\nread (boolean): a boolean indicating if this message has been read by the useruser_message_id: an internal reference number that links the message to this specific useruser_id: an internal reference number unique to each usermessage: an object that contains information about this message, this object contains:message_id: an internal reference number unique to each messagetitle: the title of this messagesubtitle: the subtitle of this messagebanner: a direct url for the banner image in this messagebody: the body of this message publish_date: the time this message was created as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry_date: the time this message will expire as a Unix timestamp in seconds from 1970-01-01 00:00:00read: a boolean indicating if this message has been read by this usertest env content
\\n\\n\",\n \"publish_date\": 1587684453,\n \"expiry_date\": null\n },\n \"read\": true\n}"}],"_postman_id":"53cda47a-7f1a-4246-a05c-46aac03ba528"},{"name":"user_message_list","id":"643bc505-dd33-4319-a7f7-d478aee1900a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/user/message/list?session_key={{user_session_key}}","description":"This request returns a list of all messages linked to a specific user. The internal reference numbers for each user message can be found here, which allows a specific message to be accessed at a later time.
\nsession_key (string): passed in using query parameters, must match the session identifier key created with the user_authenticate request in the \"Registering an account\" workflowThe response appears as an array of objects where each object contains information about an individual message as it is linked to a specific user. Each object contains:
\nuser_message_id: an internal reference number that links the message to this specific useruser_id: an internal reference number unique to each usermessage: an object that contains information about this message, this object contains:message_id: an internal reference number unique to each messagetitle: the title of this messagesubtitle: the subtitle of this messagebanner: a direct url for the banner image in this messagebody: the body of this message publish_date: the time this message was created as a Unix timestamp in seconds from 1970-01-01 00:00:00expiry_date: the time this message will expire as a Unix timestamp in seconds from 1970-01-01 00:00:00read: a boolean indicating if this message has been read by this usertest env content
\\n\\n\",\n \"publish_date\": 1587684453,\n \"expiry_date\": null\n },\n \"read\": false\n }\n]"}],"_postman_id":"643bc505-dd33-4319-a7f7-d478aee1900a"}],"id":"65056867-7301-484e-a655-5b8f8a4899e0","description":"","event":[{"listen":"prerequest","script":{"id":"17edb228-5fbb-4cd2-adf8-d81d094efb2c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"657fcd6c-2dce-416b-8cbf-1d9c68256129","type":"text/javascript","exec":[""]}}],"_postman_id":"65056867-7301-484e-a655-5b8f8a4899e0"},{"name":"other/helpers","item":[{"name":"/countries","id":"1aed3ac7-200e-447f-a5fa-9191bf0850b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/vendor/countries","description":"This request returns a list of all the countries this vendor serves. This is designed to be a helper request for form building.
\nThere are no parameters required for this request.
\nThis request returns an array of country objects, each object contains:
\ncountry_id: an internal reference number unique to each countrycode: the two letter ISO 3166-1 code associated with this countryname: indicates the country in a way that is more user friendlyphone_code: this country's calling codezip_validate: used to validate a postal or zip code for this countryphone_validate: used to validate a phone number for this countryflag_url: a url that links this country's flagThis request returns a list of all the regions within a specific country this vendor serves. This is designed to be a helper request for form building.
\ncountry (integer): provided via the url directly, the internal reference number for the country whose regions are being listedThis request returns an array of region objects, each object contains:
\nregion_id: an internal reference number unique to each regioncode: the ISO 3166-2 subdivision code for this regionname: indicates the region in a way that is more user friendlyThis request retrieves the privacy policy content set by a vendor.
\nvendor (integer): passed in using query parameters, the internal reference ID of the vendor who's content is being retrievedtitle: the title of the privacy policycontent: the content of the privacy policyLorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam vestibulum arcu vitae urna rutrum eleifend. Vivamus varius pretium gravida. Nunc sit amet felis sem. Sed commodo nisi ligula, et hendrerit ante fermentum ut. Praesent sed erat in nisl efficitur tristique. Nam at urna a enim iaculis semper. Phasellus erat felis, pretium eget eleifend id, bibendum a magna. In sit amet hendrerit magna. Sed vel sapien sodales, rhoncus urna non, bibendum felis. Suspendisse eu lacus tellus. Suspendisse potenti. Vestibulum id nisi eu lectus accumsan dapibus sit amet id sem.
\\nMauris lobortis porta risus, sollicitudin scelerisque dui accumsan sit amet. Mauris at augue non nulla luctus hendrerit et in sapien. Mauris sit amet mauris orci. Nam laoreet magna at enim molestie dictum. Mauris est orci, luctus euismod egestas ut, scelerisque nec sapien. Integer a ex eu velit hendrerit faucibus ac sit amet elit. Proin eget libero at elit blandit auctor laoreet non nisl. Phasellus purus magna, posuere a nisi ac, lobortis euismod libero. Mauris augue velit, ornare sed tortor eget, consequat bibendum ligula. Ut non vehicula orci, vel aliquam sapien. Vestibulum tempor libero nulla, sit amet vulputate dui viverra a. Duis ultrices augue sit amet arcu mollis, ut scelerisque lectus euismod. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut auctor nisl ante, non ultricies metus molestie ut. Aliquam a leo consequat, volutpat velit vitae, cursus nisl.
\\nNullam malesuada eros eu purus elementum, nec fringilla nisi congue. Maecenas placerat ligula feugiat magna porta, quis molestie tellus tempus. Nulla ac odio tempus, vulputate lacus nec, porttitor diam. Integer aliquam, ligula a facilisis auctor, nunc lacus blandit nisi, nec vehicula massa dui eu est. Quisque sollicitudin eget tortor non feugiat. Cras scelerisque sapien vel urna maximus ultrices a vitae lacus. Quisque a sem diam. Praesent scelerisque, magna eget faucibus varius, nunc metus commodo nibh, tempor semper mi tortor vel diam. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
\",\n \"version\": null\n}"}],"_postman_id":"c81c7882-14cb-4898-996b-048261f294b5"},{"name":"terms_of_service","id":"b90eb3f1-fcbf-4c63-98af-1fc7c6b1300c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/vendor/content/terms-of-service?vendor={{vendor}}","description":"This request retrieves the terms of service content set by a vendor.
\nvendor (integer): passed in using query parameters, the internal reference ID of the vendor who's content is being retrievedtitle: the title of the terms of servicecontent: the content of the terms of serviceLorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam vestibulum arcu vitae urna rutrum eleifend. Vivamus varius pretium gravida. Nunc sit amet felis sem. Sed commodo nisi ligula, et hendrerit ante fermentum ut. Praesent sed erat in nisl efficitur tristique. Nam at urna a enim iaculis semper. Phasellus erat felis, pretium eget eleifend id, bibendum a magna. In sit amet hendrerit magna. Sed vel sapien sodales, rhoncus urna non, bibendum felis. Suspendisse eu lacus tellus. Suspendisse potenti. Vestibulum id nisi eu lectus accumsan dapibus sit amet id sem.
\\nMauris lobortis porta risus, sollicitudin scelerisque dui accumsan sit amet. Mauris at augue non nulla luctus hendrerit et in sapien. Mauris sit amet mauris orci. Nam laoreet magna at enim molestie dictum. Mauris est orci, luctus euismod egestas ut, scelerisque nec sapien. Integer a ex eu velit hendrerit faucibus ac sit amet elit. Proin eget libero at elit blandit auctor laoreet non nisl. Phasellus purus magna, posuere a nisi ac, lobortis euismod libero. Mauris augue velit, ornare sed tortor eget, consequat bibendum ligula. Ut non vehicula orci, vel aliquam sapien. Vestibulum tempor libero nulla, sit amet vulputate dui viverra a. Duis ultrices augue sit amet arcu mollis, ut scelerisque lectus euismod. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut auctor nisl ante, non ultricies metus molestie ut. Aliquam a leo consequat, volutpat velit vitae, cursus nisl.
\\nNullam malesuada eros eu purus elementum, nec fringilla nisi congue. Maecenas placerat ligula feugiat magna porta, quis molestie tellus tempus. Nulla ac odio tempus, vulputate lacus nec, porttitor diam. Integer aliquam, ligula a facilisis auctor, nunc lacus blandit nisi, nec vehicula massa dui eu est. Quisque sollicitudin eget tortor non feugiat. Cras scelerisque sapien vel urna maximus ultrices a vitae lacus. Quisque a sem diam. Praesent scelerisque, magna eget faucibus varius, nunc metus commodo nibh, tempor semper mi tortor vel diam. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
\",\n \"version\": null\n}"}],"_postman_id":"b90eb3f1-fcbf-4c63-98af-1fc7c6b1300c"}],"id":"06044eed-4b75-4c16-9933-60f6935b038e","_postman_id":"06044eed-4b75-4c16-9933-60f6935b038e","description":""}]}