EndPoint Retrieve a Customer
Name
get_single_customer
Description
Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation. [API reference]
Parameters
Parameter | Label | Required | Options | Description |
---|---|---|---|---|
Id | Customer Id | YES | Unique identifier for the Customer |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
---|---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
Object |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
Name |
DT_WSTR
|
nvarchar(255)
|
255 | False | |
DT_WSTR
|
nvarchar(100)
|
100 | False | ||
Description |
DT_WSTR
|
nvarchar(4000)
|
4000 | False | |
Phone |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
PaymentMethod |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
DefaultSource |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
DefaultCurrency |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
Balance |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
Coupon |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
PreferredLocales |
DT_WSTR
|
nvarchar(100)
|
100 | True | |
PromotionCode |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
AddressLine1 |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
AddressLine2 |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
AddressCity |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
AddressState |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
AddressCountry |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
AddressPostalCode |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
ShippingName |
DT_WSTR
|
nvarchar(255)
|
255 | False | |
ShippingPhone |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
ShippingAddressLine1 |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
ShippingAddressLine2 |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
ShippingAddressCity |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
ShippingAddressCountry |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
ShippingAddressState |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
ShippingAddressPostalCode |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
TaxIDType |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
TaxIDValue |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
InvoicePrefix |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
InvoiceSettingsDefaultPaymentMethod |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
InvoiceSettingsFooter |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
NextInvoiceSequence |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
TaxExempt |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
Created |
DT_DBTIMESTAMP
|
datetime
|
False | ||
LiveMode |
DT_WSTR
|
nvarchar(100)
|
100 | False | |
Metadata |
DT_WSTR
|
nvarchar(1000)
|
1000 | False |
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
---|---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
Required columns that you need to supply are bolded.