API Field Types

API Field Types

Below is a list of field types used throughout the API.










OrderIdType numeric string with optional alpha prefix, max length 15 characters
UsernameType alphanumeric string, max length 25 characters
SKUType alphanumeric string, max length 25 characters
string character string, min length 1000 characters
string_3 character string, 3 characters maximum
string_10 character string, 10 characters maximum
string_15 character string, 15 characters maximum
string_20 character string, 20 characters maximum
string_25 character string, 25 characters maximum
string_30 character string, 30 characters maximum
string_50 character string, 50 characters maximum
string_100 character string, 100 characters maximum
string_150 character string, 150 characters maximum
string_255 character string, 255 characters maximum
boolean True or False
datetime date format YYYY-MM-DD HH:MM:SS (UTC)(
integer whole number value eg: 1
integer_2 whole number value, 2 numeral maximum eg: 12
integer_3 whole number value, 3 numeral maximum eg: 123
decimal_2 floating point number to 2 decimal places eg: 1.02
decimal_3 floating point number to 3 decimal places eg: 1.002
decimal_4 floating point number to 4 decimal places eg: 1.0002
PaymentStatusType FullyPaid
PartialPaid
Pending
StandingOrderRepeatType once
always
OrderStatusType Quote
New
On Hold
New Backorder
Backorder Approved
Pick
Pack
Pending Pickup
Pending Dispatch
Dispatched
Cancelled
Uncommitted
OrderType sales
dropshipping
CompleteStatusType Approved
Incomplete
ExportStatusType Pending
Exported
StockActionType increment
decrement
set
CustomerType Prospect
Customer
PickStatusType Complete
Incomplete
OrderOutputSelectorType ShippingOption
DeliveryInstruction
Username
Email
ShipAddress
BillAddress
CustomerRef1
CustomerRef2
CustomerRef3
CustomerRef4
SalesChannel
GrandTotal
ShippingTotal
ShippingDiscount
OrderType
OrderPayment
OrderPayment.PaymentType
DatePlaced
DateRequired
DateInvoiced
DatePaid
OrderLine
OrderLine.ProductName
OrderLine.PickQuantity
OrderLine.BackorderQuantity
OrderLine.UnitPrice
OrderLine.WarehouseID
OrderLine.Quantity
OrderLine.PercentDiscount
OrderLine.ProductDiscount
OrderLine.CostPrice
ShippingSignature
eBay.eBayUsername
eBay.eBayStoreName
eBay.eBayTransactionID
eBay.eBayAuctionID
eBay.ListingType
eBay.DateCreated
eBay.DatePaid

WarehouseOutputSelectorType WarehouseID
IsPrimary
IsActive
ShowQuantity
WarehouseReference
WarehouseName
WarehouseStreet1
WarehouseStreet2
WarehouseCity
WarehouseState
WarehousePostcode
WarehouseCountry
WarehouseContact
WarehousePhone
WarehouseNotes
CustomerOutputSelectorType BillFirstName
BillLastName
BillCompany
BillStreet1
BillStreet2
BillCity
BillState
BillPostCode
BillCountry
Username
NewsletterSubscriber
Email
SecondaryEmail
Type
Phone
Fax
Gender
DateOfBirth
RegistrationDate
Active
CreditHold
UserGroup
ABN
AccountBalance
Credit
Classification1
Classification2
CreditLimit
ResidentialProperty1
ResidentialProperty2
ResidentialCity
ResidentialCountry
ResidentialStreetNum
ResidentialState
ResidentialPostCode
ResidentialStreet
ResidentialStreetType
ResidentialUnitNum
DefaultDiscounts
DefaultInvoiceTerms
DefaultOrderType
DocumentTemplateID
IdentificationDetails
IdentificationType
ParentUsername
QuoteApprovalUsername
TotalSalesRevenue
WebsiteURL
UserCustom1
UserCustom2
UserCustom3
UserCustom4
UserCustom5
UserCustom6
UserCustom7
UserCustom8
UserCustom9
UserCustom10
UserCustom11
UserCustom12
UserCustom13
UserCustom14
UserCustom15
UserCustom16
UserCustom17
UserCustom18
UserCustom19
UserCustom20
UserCustom21
ItemOutputSelectorType ParentSKU

Brand
Model
PrimarySupplier
Approved
Visible
ItemLength
ItemWidth
ItemHeight
ShippingLength
ShippingWidth
ShippingHeight
ShippingWeight
CubicWeight
WarehouseQuantity
CommittedQuantity
ItemSpecifics

Was this article useful?

Be notified when this page is updated. Optional.