SaleMetadataRange: Tixly Sale Metadata Range |
Fetches customers by sale range, which means if the customer buys or is refunded an order in the date range it will be included. This endpoint is good to use if you are fetching from other endpoints by a specific date range, that can be matched in this endpoint to link the data. The dates are to and from and include time as well so if you would like an entire day then you need to indicate the end time of that day or the start of the next as the DateTo parameter.
Catalog: Tixly
Schema: Customer
Label: Sale Metadata Range
This is a read-only table function. The Tixly API may not support changing the data or the Invantive SQL driver for Tixly does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Tixly API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function SaleMetadataRange. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
DateFrom |
datetime |
☑ |
|
Created sale from |
DateTo |
datetime |
☑ |
|
Created sale to |
Columns of Table Function
The columns of the table function SaleMetadataRange are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
AddressOne |
string |
Address One |
☐ |
|
AddressTwo |
string |
Address Two |
☐ |
|
AlternativeEmails |
string |
Alternative Email Addresses |
☐ |
|
City |
string |
City |
☐ |
|
CompanyName |
string |
Company Name |
☐ |
|
Country |
string |
Country |
☐ |
|
CountryCode |
string |
Country Code |
☐ |
|
Created |
datetime |
Created |
☐ |
|
CreatedUTCUnix |
int64 |
|
☐ |
|
CRN |
string |
CRN |
☐ |
|
CustomerAttributeID |
int32 |
Customer Atribute ID |
☐ |
|
DateOfBirth |
datetime |
Date of Birth |
☐ |
|
DateOfBirthUTCUnix |
int64 |
|
☐ |
|
DeletedDate |
datetime |
Deleted Date |
☐ |
|
DeletedDateUTCUnix |
int64 |
|
☐ |
|
Description |
string |
Description |
☐ |
|
DisallowMerge |
boolean |
Disallow Merge |
☐ |
|
Edited |
datetime |
Edited |
☐ |
|
EditedUTCUnix |
int64 |
|
☐ |
|
string |
☐ |
|
||
FirstName |
string |
First Name |
☐ |
|
Gender |
int32 |
Gender |
☐ |
|
HomePhone |
string |
Home Phone |
☐ |
|
HouseExtension |
string |
House Extension |
☐ |
|
HouseNumber |
string |
House Number |
☐ |
|
Id |
int32 |
ID |
☐ |
|
Initials |
string |
Initials |
☐ |
|
IsAnonymized |
boolean |
Is Anonymized |
☐ |
|
IsDeleted |
boolean |
Is Deleted |
☐ |
|
LanguageId |
int32 |
Language ID |
☐ |
|
LastName |
string |
Last Name |
☐ |
|
LastNamePrefix |
string |
Last Name Prefix |
☐ |
|
Latitude |
double |
Latitude |
☐ |
|
Longitude |
double |
Longitude |
☐ |
|
Mobile |
string |
Mobile |
☐ |
|
Name_1 |
string |
Name 1 |
☐ |
|
Name |
string |
Name |
☐ |
|
SSN |
string |
SSN |
☐ |
|
StreetName |
string |
Street Name |
☐ |
|
Title |
string |
Title |
☐ |
|
Value |
string |
Value |
☐ |
|
WorkPhone |
string |
Work Phone |
☐ |
|
ZipCode |
string |
ZIP-code |
☐ |
|
22-12-2022 21:15 Version 22.1.101-BETA+3681