1. Knowledge Center
  2. Partner & Integration Community

How do we integrate with 3rd Party Sales?

Our system integrates with any Sales platform that supports RESTful APIs. See the article below for the details.

Table of Contents

NOTE:

To complete your connection, please contact support@sculpturehospitality.com


Format

The required URL format is as follows.
https://your_domain_name/your_directory/<id_1>/<id_2>/<syear>/<smonth>/<sday>/<shour>/<smin>/<eyear>/<emonth>/<eday>/<ehour>/<emin>

We assume our vendors identify their clients uniquely using two IDs, but if you only use one, you can always set id_1 as 1, and id_2 to be your client's unique ID.

    • <id_1> 
    • <id_2> 

Starting Date Timestamp

  • sXXX is the starting date-timestamp of the sales transactions we want to return back

Ending Date Timestamp

  • eXXX is the ending date-timestamp of the sales transactions we want to return back

Requirements

Below is an outline of the requirements for the connection.

  • Your server needs to respond within 4 seconds or our server will close the connection
  • The format of the data stream is plain text
  • The columns need to be pipe (|) separated.
  • The first line is always the header like this:
Date_Ordered|orderID|OrderItemID|Terminal|ItemID|ItemName|RetailPrice|Quantity

Sample Lines

Following the header, lines that follow would appear as the sample

3/5/2021 8:00:09 PM|432488|1|1|2244|Pint Rolling Rock|7.55|1|
3/5/2021 8:00:27 PM|432489|1|1|2735|Fireball|6.2|4|
3/5/2021 8:18:57 PM|432504|1|1|2036|Half Fries|5|1|