Skip to main content

Add new cart

Add new cart

Authorizations:Token
Request Body Schema:
Cart object that needs to be added
uspsShipmentArray of objects (USPS Shipments)USPS Shipments
Array
idinteger
transactionIdstring
order
requestDataArray
responseDataArray
printDateinteger
pricestring
shipmentIdstring
trackingNumberstring
trackingDataArray
labelURLstring
labelContentArray
capostParcelsArray of objects (Canada Post parcels (reference to the Canada Post parcels model))Canada Post parcels (reference to the Canada Post parcels model)
Array
idinteger
numberinteger
statusstring
quoteTypestring
order
itemsArray
shipment
boxWeightstring
boxWidthstring
boxLengthstring
boxHeightstring
isDocumentboolean
isUnpackagedboolean
isMailingTubeboolean
isOversizedboolean
notifyOnShipmentboolean
notifyOnExceptionboolean
notifyOnDeliveryboolean
optSignatureboolean
optCoveragestring
optAgeProofstring
optWayToDeliverstring
optNonDeliverystring
hasRemovedItemsboolean
capostReturnsArray of objects (Reference to the Canada Post returns model)Reference to the Canada Post returns model
Array
idinteger
itemsArray
linksArray
order
statusstring
dateinteger
lastRenewDateinteger
notesstring
adminNotesstring
trackingPinstring
capostOfficeobject
idintegerUnique ID
order
officeIdstringThe internal Canada Post assigned unique ID for a Post Office (Field pattern: "\d{10}", has leading zeros)
namestringThe name assigned to the Post Office (Max length: 40)
locationstringThe location of a Post Office. This is used to distinguish among various Post Offices that have similar names. (Max length: 40)
distancestringThe distance (in KM) to the Post Office from the location specified in the query (min: 0, max: 99999.99, fraction: 2)
bilingualDesignationbooleanTrue indicates that the Post Office provides bilingual services (English and French)
citystringMunicipality in which the Post Office is located (Max length: 40)
latitudestringThe latitude of the Post Office (min: 40, max: 90, fraction: 5)
longitudestringThe longitude of the Post Office (min: -150, max: -50, fraction: 5)
postalCodestringThe Postal Code of the Post Office
provincestringThe province where the Post Office is located
officeAddressstringStreet number and name for a Post Office (Max length: 64)
workingHoursArrayWorking hours list
mailchimpStoreIdstringMailchimp store id
not_finished_orderobject
uspsShipmentArrayUSPS Shipments
capostParcelsArrayCanada Post parcels (reference to the Canada Post parcels model)
capostReturnsArrayReference to the Canada Post returns model
capostOffice
mailchimpStoreIdstringMailchimp store id
not_finished_order
demobooleanFlag, if the product participates in the sale
is_opened_disputebooleanHas opened disputes flag
conversation
childrenArrayList of carts by vendors
parent
vendor
commission
profileTransactionsArrayProfile transactions for shop owner
vendorRatingsArray of objects (Vendor ratings for the order)Vendor ratings for the order
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArrayUsed coupons
reviewKey
order_idintegerOrder unique id
profile
orig_profile
shipping_idintegerShipping method unique id
shipping_method_namestringShipping method name
payment_method_namestringPayment method name
trackingstringShipping tracking code
dateintegerOrder creation timestamp
lastRenewDateintegerLast order renew date
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstringCustomer notes
adminNotesstringAdmin notes
detailsArrayOrder details
trackingNumbersArrayOrder tracking numbers
eventsArrayOrder events queue
itemsArrayOrder items
surchargesArrayOrder surcharges
payment_transactionsArrayPayment transactions
currency
orderNumberstringUnique order identificator (it is working for orders only, not for cart entities)
recentbooleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExportbooleanFlag to exporting entities
backorderCompetitorsArrayProfiles
totalstringTotal
subtotalstringSubtotal
demobooleanFlag, if the product participates in the sale
is_opened_disputebooleanHas opened disputes flag
conversationobject
idintegerUnique ID
messagesArrayMessages
order
membersArrayConversation members
childrenArray of objects (List of carts by vendors)List of carts by vendors
Array
uspsShipmentArray
capostParcelsArray
capostReturnsArray
capostOffice
mailchimpStoreIdstring
not_finished_order
demoboolean
is_opened_disputeboolean
conversation
childrenArray
parent
vendor
commission
profileTransactionsArray
vendorRatingsArray of objects
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArray
reviewKey
order_idinteger
profile
orig_profile
shipping_idinteger
shipping_method_namestring
payment_method_namestring
trackingstring
dateinteger
lastRenewDateinteger
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstring
adminNotesstring
detailsArray
trackingNumbersArray
eventsArray
itemsArray
surchargesArray
payment_transactionsArray
currency
orderNumberstring
recentboolean
xcPendingExportboolean
backorderCompetitorsArray
totalstring
subtotalstring
parentobject
uspsShipmentArrayUSPS Shipments
capostParcelsArrayCanada Post parcels (reference to the Canada Post parcels model)
capostReturnsArrayReference to the Canada Post returns model
capostOffice
mailchimpStoreIdstringMailchimp store id
not_finished_order
demobooleanFlag, if the product participates in the sale
is_opened_disputebooleanHas opened disputes flag
conversation
childrenArrayList of carts by vendors
parent
vendor
commission
profileTransactionsArrayProfile transactions for shop owner
vendorRatingsArray of objects (Vendor ratings for the order)Vendor ratings for the order
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArrayUsed coupons
reviewKey
order_idintegerOrder unique id
profile
orig_profile
shipping_idintegerShipping method unique id
shipping_method_namestringShipping method name
payment_method_namestringPayment method name
trackingstringShipping tracking code
dateintegerOrder creation timestamp
lastRenewDateintegerLast order renew date
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstringCustomer notes
adminNotesstringAdmin notes
detailsArrayOrder details
trackingNumbersArrayOrder tracking numbers
eventsArrayOrder events queue
itemsArrayOrder items
surchargesArrayOrder surcharges
payment_transactionsArrayPayment transactions
currency
orderNumberstringUnique order identificator (it is working for orders only, not for cart entities)
recentbooleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExportbooleanFlag to exporting entities
backorderCompetitorsArrayProfiles
totalstringTotal
subtotalstringSubtotal
vendorobject
socialLoginProviderstringAuth provider (amazon)
socialLoginIdstringAuth provider-unique user id (for ex. facebook user id)
gaClientIdstringGoogle analytics cid
wizardStatestringVendor wizard state
conciergeUserIdstring
mail_chimp_listsArrayMailChimp lists
mail_chimp_interestsArrayMailChimp lists
mail_chimp_segmentsArrayMailChimp segments
vendorImage
vendor
cleanURLsArrayClean URLs
shippingMethodsArrayShipping methods
vendorConfigArrayVendor config
vendorRoleRequestedbooleanVendor role requested
paypalLoginstringPaypal login (email)
firstNamestringPaypal first name
lastNamestringPaypal last name
paypalLoginStatusstringPaypal login status
paypalConnectionStatusstringPaypal login status
bankDetailsstringBank details
paypalMerchantIdstringPaypal merchant id
paypalPartnerReferralIdstringPaypal partner referral id
profileTransactionsArrayProfileTransactions
lastShippingIdByVendorArrayLast shipping id (by order vendor)
specialRevshareFeeDststringRevshare fee value
hasSpecialRevshareFeeDstbooleanRevshare fee type flag
specialRevshareFeeShippingstringRevshare fee shipping value
hasSpecialRevshareFeeShippingbooleanRevshare fee shipping type flag
companyFieldValuesArrayValues
productsArrayProducts
conversationsArrayCoupons
profile_idintegerProfile unique ID
loginstringLogin (e-mail)
passwordstringPassword
password_hintstringPassword hint
password_hint_answerstringPassword hint answer
passwordResetKeystringPassword reset key (for 'Forgot password')
passwordResetKeyDateintegerTimestamp of reset key creation date
access_levelintegerAccess level
cms_profile_idintegerCMS profile Id
cms_namestringCMS name
addedintegerTimestamp of profile creation date
first_loginintegerTimestamp of first login event
last_loginintegerTimestamp of last login event
statusstringProfile status
statusCommentstringStatus comment (reason)
refererstringReferer
order
eventArrayRelation to an event
languagestringLanguage code
last_shipping_idintegerLast selected shipping id
last_payment_idintegerLast selected payment id
membershipobject (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table
pending_membershipobject (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table
addressesArrayAddress book: one-to-many relation with address book entity
rolesArrayRoles
anonymousbooleanFlag of anonymous profile (used for checkout process only)
forceChangePasswordbooleanFlag if the user needs to change the password. The customers only
dateOfLoginAttemptintegerDate of last login attempt
countOfLoginAttemptsintegerCount of login attempt
searchFakeFieldstringFake field for search
xcPendingExportbooleanFlag to exporting entities
lastCheckoutEmailstringCheckout email
commissionobject
idintegerId
valuestringCommission value
statusstringStatus
autobooleanAuto paid state
order
taxesOwnerstringStatus
profileTransactionsArray of objects (Profile transactions for shop owner)Profile transactions for shop owner
Array
idinteger
datestring
valuestring
profile
author
providerstring
statusstring
order
descriptionstring
vendorRatingsArray of objects (Vendor ratings for the order)Vendor ratings for the order
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArray of objects (Used coupons)Used coupons
Array
idinteger
codestring
valuestring
order
coupon
typestring
reviewKeyobject
idintegerUnique key ID
keyValuestringKey value
addedDateintegerDate when key was created (UNIX timestamp)
sentDateintegerDate when key was sent (UNIX timestamp)
firstClickDateintegerDate when customer first time clicked by link with review key (UNIX timestamp)
order
reviewsArrayRelation to a profile entity (who adds review)
order_idintegerOrder unique id
profileobject
socialLoginProviderstringAuth provider (amazon)
socialLoginIdstringAuth provider-unique user id (for ex. facebook user id)
gaClientIdstringGoogle analytics cid
wizardStatestringVendor wizard state
conciergeUserIdstring
mail_chimp_listsArrayMailChimp lists
mail_chimp_interestsArrayMailChimp lists
mail_chimp_segmentsArrayMailChimp segments
vendorImage
vendor
cleanURLsArrayClean URLs
shippingMethodsArrayShipping methods
vendorConfigArrayVendor config
vendorRoleRequestedbooleanVendor role requested
paypalLoginstringPaypal login (email)
firstNamestringPaypal first name
lastNamestringPaypal last name
paypalLoginStatusstringPaypal login status
paypalConnectionStatusstringPaypal login status
bankDetailsstringBank details
paypalMerchantIdstringPaypal merchant id
paypalPartnerReferralIdstringPaypal partner referral id
profileTransactionsArrayProfileTransactions
lastShippingIdByVendorArrayLast shipping id (by order vendor)
specialRevshareFeeDststringRevshare fee value
hasSpecialRevshareFeeDstbooleanRevshare fee type flag
specialRevshareFeeShippingstringRevshare fee shipping value
hasSpecialRevshareFeeShippingbooleanRevshare fee shipping type flag
companyFieldValuesArrayValues
productsArrayProducts
conversationsArrayCoupons
profile_idintegerProfile unique ID
loginstringLogin (e-mail)
passwordstringPassword
password_hintstringPassword hint
password_hint_answerstringPassword hint answer
passwordResetKeystringPassword reset key (for 'Forgot password')
passwordResetKeyDateintegerTimestamp of reset key creation date
access_levelintegerAccess level
cms_profile_idintegerCMS profile Id
cms_namestringCMS name
addedintegerTimestamp of profile creation date
first_loginintegerTimestamp of first login event
last_loginintegerTimestamp of last login event
statusstringProfile status
statusCommentstringStatus comment (reason)
refererstringReferer
order
eventArrayRelation to an event
languagestringLanguage code
last_shipping_idintegerLast selected shipping id
last_payment_idintegerLast selected payment id
membershipobject (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table
pending_membershipobject (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table
addressesArrayAddress book: one-to-many relation with address book entity
rolesArrayRoles
anonymousbooleanFlag of anonymous profile (used for checkout process only)
forceChangePasswordbooleanFlag if the user needs to change the password. The customers only
dateOfLoginAttemptintegerDate of last login attempt
countOfLoginAttemptsintegerCount of login attempt
searchFakeFieldstringFake field for search
xcPendingExportbooleanFlag to exporting entities
lastCheckoutEmailstringCheckout email
orig_profileobject
socialLoginProviderstringAuth provider (amazon)
socialLoginIdstringAuth provider-unique user id (for ex. facebook user id)
gaClientIdstringGoogle analytics cid
wizardStatestringVendor wizard state
conciergeUserIdstring
mail_chimp_listsArrayMailChimp lists
mail_chimp_interestsArrayMailChimp lists
mail_chimp_segmentsArrayMailChimp segments
vendorImage
vendor
cleanURLsArrayClean URLs
shippingMethodsArrayShipping methods
vendorConfigArrayVendor config
vendorRoleRequestedbooleanVendor role requested
paypalLoginstringPaypal login (email)
firstNamestringPaypal first name
lastNamestringPaypal last name
paypalLoginStatusstringPaypal login status
paypalConnectionStatusstringPaypal login status
bankDetailsstringBank details
paypalMerchantIdstringPaypal merchant id
paypalPartnerReferralIdstringPaypal partner referral id
profileTransactionsArrayProfileTransactions
lastShippingIdByVendorArrayLast shipping id (by order vendor)
specialRevshareFeeDststringRevshare fee value
hasSpecialRevshareFeeDstbooleanRevshare fee type flag
specialRevshareFeeShippingstringRevshare fee shipping value
hasSpecialRevshareFeeShippingbooleanRevshare fee shipping type flag
companyFieldValuesArrayValues
productsArrayProducts
conversationsArrayCoupons
profile_idintegerProfile unique ID
loginstringLogin (e-mail)
passwordstringPassword
password_hintstringPassword hint
password_hint_answerstringPassword hint answer
passwordResetKeystringPassword reset key (for 'Forgot password')
passwordResetKeyDateintegerTimestamp of reset key creation date
access_levelintegerAccess level
cms_profile_idintegerCMS profile Id
cms_namestringCMS name
addedintegerTimestamp of profile creation date
first_loginintegerTimestamp of first login event
last_loginintegerTimestamp of last login event
statusstringProfile status
statusCommentstringStatus comment (reason)
refererstringReferer
order
eventArrayRelation to an event
languagestringLanguage code
last_shipping_idintegerLast selected shipping id
last_payment_idintegerLast selected payment id
membershipobject (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table
pending_membershipobject (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table
addressesArrayAddress book: one-to-many relation with address book entity
rolesArrayRoles
anonymousbooleanFlag of anonymous profile (used for checkout process only)
forceChangePasswordbooleanFlag if the user needs to change the password. The customers only
dateOfLoginAttemptintegerDate of last login attempt
countOfLoginAttemptsintegerCount of login attempt
searchFakeFieldstringFake field for search
xcPendingExportbooleanFlag to exporting entities
lastCheckoutEmailstringCheckout email
shipping_idintegerShipping method unique id
shipping_method_namestringShipping method name
payment_method_namestringPayment method name
trackingstringShipping tracking code
dateintegerOrder creation timestamp
lastRenewDateintegerLast order renew date
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstringCustomer notes
adminNotesstringAdmin notes
detailsArray of objects (Order details)Order details
Array
detail_idinteger
namestring
labelstring
valuestring
order
trackingNumbersArray of objects (Order tracking numbers)Order tracking numbers
Array
vendor
tracking_idinteger
valuestring
creationDateinteger
order
eventsArray of objects (Order events queue)Order events queue
Array
event_idinteger
dateinteger
codestring
descriptionstring
dataArray
commentstring
detailsArray
order
author
authorNamestring
authorIpstring
itemsArray of objects (Order items)Order items
Array
privateAttachmentsArray
categoryAddedstring
pinCodesArray
capostParcelItemsArray
capostReturnItemsArray
customerAttachmentsArray
vendor
originalProduct
item_idinteger
object
namestring
skustring
pricestring
itemNetPricestring
discountedSubtotalstring
amountinteger
backorderedAmountinteger
order
surchargesArray
attributeValuesArray
totalstring
subtotalstring
surchargesArray of objects (Order surcharges)Order surcharges
Array
owner
idinteger
typestring
codestring
classstring
includeboolean
availableboolean
valuestring
namestring
weightinteger
payment_transactionsArray of objects (Payment transactions)Payment transactions
Array
payPalAdaptiveProfileTransactionsCreatedboolean
transaction_idinteger
dateinteger
publicTxnIdstring
method_namestring
method_local_namestring
statusstring
valuestring
notestring
typestring
public_idstring
order
payment_methodobject
method_idintegerPayment method unique id
service_namestringMethod service name (gateway or API name)
classstringProcess class name
moduleNamestringSpecific module family name
orderbyintegerPosition
adminOrderbyintegerPosition in popup
enabledbooleanEnabled status
addedbooleanAdded status
typestringType
settingsArraySettings
fromMarketplacebooleanFlag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURLstringPayment method icon URL (used for methods from marketplace)
countriesArrayCountries of merchant (merchants from these countries can sign up and use this method)
exCountriesArrayExcluded countries (merchants from these countries cannot sign up for payment account)
countryPositionsArraySettings
dataArray
backend_transactionsArray
currency
currencyobject
currency_idintegerCurrency unique id (ISO 4217 number)
codestringCurrency code (ISO 4217 alpha-3)
symbolstringSymbol
prefixstringPrefix
suffixstringSuffix
estringNumber of digits after the decimal separator.
decimalDelimiterstringDecimal part delimiter
thousandDelimiterstringThousand delimier
ordersArrayOrders
countriesArrayCountries
roundUpstringRoundUp
orderNumberstringUnique order identificator (it is working for orders only, not for cart entities)
recentbooleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExportbooleanFlag to exporting entities
backorderCompetitorsArray of objects (Profiles)Profiles
Array
uspsShipmentArray
capostParcelsArray
capostReturnsArray
capostOffice
mailchimpStoreIdstring
not_finished_order
demoboolean
is_opened_disputeboolean
conversation
childrenArray
parent
vendor
commission
profileTransactionsArray
vendorRatingsArray of objects
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArray
reviewKey
order_idinteger
profile
orig_profile
shipping_idinteger
shipping_method_namestring
payment_method_namestring
trackingstring
dateinteger
lastRenewDateinteger
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstring
adminNotesstring
detailsArray
trackingNumbersArray
eventsArray
itemsArray
surchargesArray
payment_transactionsArray
currency
orderNumberstring
recentboolean
xcPendingExportboolean
backorderCompetitorsArray
totalstring
subtotalstring
totalstringTotal
subtotalstringSubtotal

Responses

200Success
Response schema:
Success
uspsShipmentArray of objects (USPS Shipments)USPS Shipments
Array
idinteger
transactionIdstring
order
requestDataArray
responseDataArray
printDateinteger
pricestring
shipmentIdstring
trackingNumberstring
trackingDataArray
labelURLstring
labelContentArray
capostParcelsArray of objects (Canada Post parcels (reference to the Canada Post parcels model))Canada Post parcels (reference to the Canada Post parcels model)
Array
idinteger
numberinteger
statusstring
quoteTypestring
order
itemsArray
shipment
boxWeightstring
boxWidthstring
boxLengthstring
boxHeightstring
isDocumentboolean
isUnpackagedboolean
isMailingTubeboolean
isOversizedboolean
notifyOnShipmentboolean
notifyOnExceptionboolean
notifyOnDeliveryboolean
optSignatureboolean
optCoveragestring
optAgeProofstring
optWayToDeliverstring
optNonDeliverystring
hasRemovedItemsboolean
capostReturnsArray of objects (Reference to the Canada Post returns model)Reference to the Canada Post returns model
Array
idinteger
itemsArray
linksArray
order
statusstring
dateinteger
lastRenewDateinteger
notesstring
adminNotesstring
trackingPinstring
capostOfficeobject
idintegerUnique ID
order
officeIdstringThe internal Canada Post assigned unique ID for a Post Office (Field pattern: "\d{10}", has leading zeros)
namestringThe name assigned to the Post Office (Max length: 40)
locationstringThe location of a Post Office. This is used to distinguish among various Post Offices that have similar names. (Max length: 40)
distancestringThe distance (in KM) to the Post Office from the location specified in the query (min: 0, max: 99999.99, fraction: 2)
bilingualDesignationbooleanTrue indicates that the Post Office provides bilingual services (English and French)
citystringMunicipality in which the Post Office is located (Max length: 40)
latitudestringThe latitude of the Post Office (min: 40, max: 90, fraction: 5)
longitudestringThe longitude of the Post Office (min: -150, max: -50, fraction: 5)
postalCodestringThe Postal Code of the Post Office
provincestringThe province where the Post Office is located
officeAddressstringStreet number and name for a Post Office (Max length: 64)
workingHoursArrayWorking hours list
mailchimpStoreIdstringMailchimp store id
not_finished_orderobject
uspsShipmentArrayUSPS Shipments
capostParcelsArrayCanada Post parcels (reference to the Canada Post parcels model)
capostReturnsArrayReference to the Canada Post returns model
capostOffice
mailchimpStoreIdstringMailchimp store id
not_finished_order
demobooleanFlag, if the product participates in the sale
is_opened_disputebooleanHas opened disputes flag
conversation
childrenArrayList of carts by vendors
parent
vendor
commission
profileTransactionsArrayProfile transactions for shop owner
vendorRatingsArray of objects (Vendor ratings for the order)Vendor ratings for the order
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArrayUsed coupons
reviewKey
order_idintegerOrder unique id
profile
orig_profile
shipping_idintegerShipping method unique id
shipping_method_namestringShipping method name
payment_method_namestringPayment method name
trackingstringShipping tracking code
dateintegerOrder creation timestamp
lastRenewDateintegerLast order renew date
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstringCustomer notes
adminNotesstringAdmin notes
detailsArrayOrder details
trackingNumbersArrayOrder tracking numbers
eventsArrayOrder events queue
itemsArrayOrder items
surchargesArrayOrder surcharges
payment_transactionsArrayPayment transactions
currency
orderNumberstringUnique order identificator (it is working for orders only, not for cart entities)
recentbooleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExportbooleanFlag to exporting entities
backorderCompetitorsArrayProfiles
totalstringTotal
subtotalstringSubtotal
demobooleanFlag, if the product participates in the sale
is_opened_disputebooleanHas opened disputes flag
conversationobject
idintegerUnique ID
messagesArrayMessages
order
membersArrayConversation members
childrenArray of objects (List of carts by vendors)List of carts by vendors
Array
uspsShipmentArray
capostParcelsArray
capostReturnsArray
capostOffice
mailchimpStoreIdstring
not_finished_order
demoboolean
is_opened_disputeboolean
conversation
childrenArray
parent
vendor
commission
profileTransactionsArray
vendorRatingsArray of objects
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArray
reviewKey
order_idinteger
profile
orig_profile
shipping_idinteger
shipping_method_namestring
payment_method_namestring
trackingstring
dateinteger
lastRenewDateinteger
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstring
adminNotesstring
detailsArray
trackingNumbersArray
eventsArray
itemsArray
surchargesArray
payment_transactionsArray
currency
orderNumberstring
recentboolean
xcPendingExportboolean
backorderCompetitorsArray
totalstring
subtotalstring
parentobject
uspsShipmentArrayUSPS Shipments
capostParcelsArrayCanada Post parcels (reference to the Canada Post parcels model)
capostReturnsArrayReference to the Canada Post returns model
capostOffice
mailchimpStoreIdstringMailchimp store id
not_finished_order
demobooleanFlag, if the product participates in the sale
is_opened_disputebooleanHas opened disputes flag
conversation
childrenArrayList of carts by vendors
parent
vendor
commission
profileTransactionsArrayProfile transactions for shop owner
vendorRatingsArray of objects (Vendor ratings for the order)Vendor ratings for the order
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArrayUsed coupons
reviewKey
order_idintegerOrder unique id
profile
orig_profile
shipping_idintegerShipping method unique id
shipping_method_namestringShipping method name
payment_method_namestringPayment method name
trackingstringShipping tracking code
dateintegerOrder creation timestamp
lastRenewDateintegerLast order renew date
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstringCustomer notes
adminNotesstringAdmin notes
detailsArrayOrder details
trackingNumbersArrayOrder tracking numbers
eventsArrayOrder events queue
itemsArrayOrder items
surchargesArrayOrder surcharges
payment_transactionsArrayPayment transactions
currency
orderNumberstringUnique order identificator (it is working for orders only, not for cart entities)
recentbooleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExportbooleanFlag to exporting entities
backorderCompetitorsArrayProfiles
totalstringTotal
subtotalstringSubtotal
vendorobject
socialLoginProviderstringAuth provider (amazon)
socialLoginIdstringAuth provider-unique user id (for ex. facebook user id)
gaClientIdstringGoogle analytics cid
wizardStatestringVendor wizard state
conciergeUserIdstring
mail_chimp_listsArrayMailChimp lists
mail_chimp_interestsArrayMailChimp lists
mail_chimp_segmentsArrayMailChimp segments
vendorImage
vendor
cleanURLsArrayClean URLs
shippingMethodsArrayShipping methods
vendorConfigArrayVendor config
vendorRoleRequestedbooleanVendor role requested
paypalLoginstringPaypal login (email)
firstNamestringPaypal first name
lastNamestringPaypal last name
paypalLoginStatusstringPaypal login status
paypalConnectionStatusstringPaypal login status
bankDetailsstringBank details
paypalMerchantIdstringPaypal merchant id
paypalPartnerReferralIdstringPaypal partner referral id
profileTransactionsArrayProfileTransactions
lastShippingIdByVendorArrayLast shipping id (by order vendor)
specialRevshareFeeDststringRevshare fee value
hasSpecialRevshareFeeDstbooleanRevshare fee type flag
specialRevshareFeeShippingstringRevshare fee shipping value
hasSpecialRevshareFeeShippingbooleanRevshare fee shipping type flag
companyFieldValuesArrayValues
productsArrayProducts
conversationsArrayCoupons
profile_idintegerProfile unique ID
loginstringLogin (e-mail)
passwordstringPassword
password_hintstringPassword hint
password_hint_answerstringPassword hint answer
passwordResetKeystringPassword reset key (for 'Forgot password')
passwordResetKeyDateintegerTimestamp of reset key creation date
access_levelintegerAccess level
cms_profile_idintegerCMS profile Id
cms_namestringCMS name
addedintegerTimestamp of profile creation date
first_loginintegerTimestamp of first login event
last_loginintegerTimestamp of last login event
statusstringProfile status
statusCommentstringStatus comment (reason)
refererstringReferer
order
eventArrayRelation to an event
languagestringLanguage code
last_shipping_idintegerLast selected shipping id
last_payment_idintegerLast selected payment id
membershipobject (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table
pending_membershipobject (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table
addressesArrayAddress book: one-to-many relation with address book entity
rolesArrayRoles
anonymousbooleanFlag of anonymous profile (used for checkout process only)
forceChangePasswordbooleanFlag if the user needs to change the password. The customers only
dateOfLoginAttemptintegerDate of last login attempt
countOfLoginAttemptsintegerCount of login attempt
searchFakeFieldstringFake field for search
xcPendingExportbooleanFlag to exporting entities
lastCheckoutEmailstringCheckout email
commissionobject
idintegerId
valuestringCommission value
statusstringStatus
autobooleanAuto paid state
order
taxesOwnerstringStatus
profileTransactionsArray of objects (Profile transactions for shop owner)Profile transactions for shop owner
Array
idinteger
datestring
valuestring
profile
author
providerstring
statusstring
order
descriptionstring
vendorRatingsArray of objects (Vendor ratings for the order)Vendor ratings for the order
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArray of objects (Used coupons)Used coupons
Array
idinteger
codestring
valuestring
order
coupon
typestring
reviewKeyobject
idintegerUnique key ID
keyValuestringKey value
addedDateintegerDate when key was created (UNIX timestamp)
sentDateintegerDate when key was sent (UNIX timestamp)
firstClickDateintegerDate when customer first time clicked by link with review key (UNIX timestamp)
order
reviewsArrayRelation to a profile entity (who adds review)
order_idintegerOrder unique id
profileobject
socialLoginProviderstringAuth provider (amazon)
socialLoginIdstringAuth provider-unique user id (for ex. facebook user id)
gaClientIdstringGoogle analytics cid
wizardStatestringVendor wizard state
conciergeUserIdstring
mail_chimp_listsArrayMailChimp lists
mail_chimp_interestsArrayMailChimp lists
mail_chimp_segmentsArrayMailChimp segments
vendorImage
vendor
cleanURLsArrayClean URLs
shippingMethodsArrayShipping methods
vendorConfigArrayVendor config
vendorRoleRequestedbooleanVendor role requested
paypalLoginstringPaypal login (email)
firstNamestringPaypal first name
lastNamestringPaypal last name
paypalLoginStatusstringPaypal login status
paypalConnectionStatusstringPaypal login status
bankDetailsstringBank details
paypalMerchantIdstringPaypal merchant id
paypalPartnerReferralIdstringPaypal partner referral id
profileTransactionsArrayProfileTransactions
lastShippingIdByVendorArrayLast shipping id (by order vendor)
specialRevshareFeeDststringRevshare fee value
hasSpecialRevshareFeeDstbooleanRevshare fee type flag
specialRevshareFeeShippingstringRevshare fee shipping value
hasSpecialRevshareFeeShippingbooleanRevshare fee shipping type flag
companyFieldValuesArrayValues
productsArrayProducts
conversationsArrayCoupons
profile_idintegerProfile unique ID
loginstringLogin (e-mail)
passwordstringPassword
password_hintstringPassword hint
password_hint_answerstringPassword hint answer
passwordResetKeystringPassword reset key (for 'Forgot password')
passwordResetKeyDateintegerTimestamp of reset key creation date
access_levelintegerAccess level
cms_profile_idintegerCMS profile Id
cms_namestringCMS name
addedintegerTimestamp of profile creation date
first_loginintegerTimestamp of first login event
last_loginintegerTimestamp of last login event
statusstringProfile status
statusCommentstringStatus comment (reason)
refererstringReferer
order
eventArrayRelation to an event
languagestringLanguage code
last_shipping_idintegerLast selected shipping id
last_payment_idintegerLast selected payment id
membershipobject (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table
pending_membershipobject (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table
addressesArrayAddress book: one-to-many relation with address book entity
rolesArrayRoles
anonymousbooleanFlag of anonymous profile (used for checkout process only)
forceChangePasswordbooleanFlag if the user needs to change the password. The customers only
dateOfLoginAttemptintegerDate of last login attempt
countOfLoginAttemptsintegerCount of login attempt
searchFakeFieldstringFake field for search
xcPendingExportbooleanFlag to exporting entities
lastCheckoutEmailstringCheckout email
orig_profileobject
socialLoginProviderstringAuth provider (amazon)
socialLoginIdstringAuth provider-unique user id (for ex. facebook user id)
gaClientIdstringGoogle analytics cid
wizardStatestringVendor wizard state
conciergeUserIdstring
mail_chimp_listsArrayMailChimp lists
mail_chimp_interestsArrayMailChimp lists
mail_chimp_segmentsArrayMailChimp segments
vendorImage
vendor
cleanURLsArrayClean URLs
shippingMethodsArrayShipping methods
vendorConfigArrayVendor config
vendorRoleRequestedbooleanVendor role requested
paypalLoginstringPaypal login (email)
firstNamestringPaypal first name
lastNamestringPaypal last name
paypalLoginStatusstringPaypal login status
paypalConnectionStatusstringPaypal login status
bankDetailsstringBank details
paypalMerchantIdstringPaypal merchant id
paypalPartnerReferralIdstringPaypal partner referral id
profileTransactionsArrayProfileTransactions
lastShippingIdByVendorArrayLast shipping id (by order vendor)
specialRevshareFeeDststringRevshare fee value
hasSpecialRevshareFeeDstbooleanRevshare fee type flag
specialRevshareFeeShippingstringRevshare fee shipping value
hasSpecialRevshareFeeShippingbooleanRevshare fee shipping type flag
companyFieldValuesArrayValues
productsArrayProducts
conversationsArrayCoupons
profile_idintegerProfile unique ID
loginstringLogin (e-mail)
passwordstringPassword
password_hintstringPassword hint
password_hint_answerstringPassword hint answer
passwordResetKeystringPassword reset key (for 'Forgot password')
passwordResetKeyDateintegerTimestamp of reset key creation date
access_levelintegerAccess level
cms_profile_idintegerCMS profile Id
cms_namestringCMS name
addedintegerTimestamp of profile creation date
first_loginintegerTimestamp of first login event
last_loginintegerTimestamp of last login event
statusstringProfile status
statusCommentstringStatus comment (reason)
refererstringReferer
order
eventArrayRelation to an event
languagestringLanguage code
last_shipping_idintegerLast selected shipping id
last_payment_idintegerLast selected payment id
membershipobject (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table
pending_membershipobject (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table
addressesArrayAddress book: one-to-many relation with address book entity
rolesArrayRoles
anonymousbooleanFlag of anonymous profile (used for checkout process only)
forceChangePasswordbooleanFlag if the user needs to change the password. The customers only
dateOfLoginAttemptintegerDate of last login attempt
countOfLoginAttemptsintegerCount of login attempt
searchFakeFieldstringFake field for search
xcPendingExportbooleanFlag to exporting entities
lastCheckoutEmailstringCheckout email
shipping_idintegerShipping method unique id
shipping_method_namestringShipping method name
payment_method_namestringPayment method name
trackingstringShipping tracking code
dateintegerOrder creation timestamp
lastRenewDateintegerLast order renew date
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstringCustomer notes
adminNotesstringAdmin notes
detailsArray of objects (Order details)Order details
Array
detail_idinteger
namestring
labelstring
valuestring
order
trackingNumbersArray of objects (Order tracking numbers)Order tracking numbers
Array
vendor
tracking_idinteger
valuestring
creationDateinteger
order
eventsArray of objects (Order events queue)Order events queue
Array
event_idinteger
dateinteger
codestring
descriptionstring
dataArray
commentstring
detailsArray
order
author
authorNamestring
authorIpstring
itemsArray of objects (Order items)Order items
Array
privateAttachmentsArray
categoryAddedstring
pinCodesArray
capostParcelItemsArray
capostReturnItemsArray
customerAttachmentsArray
vendor
originalProduct
item_idinteger
object
namestring
skustring
pricestring
itemNetPricestring
discountedSubtotalstring
amountinteger
backorderedAmountinteger
order
surchargesArray
attributeValuesArray
totalstring
subtotalstring
surchargesArray of objects (Order surcharges)Order surcharges
Array
owner
idinteger
typestring
codestring
classstring
includeboolean
availableboolean
valuestring
namestring
weightinteger
payment_transactionsArray of objects (Payment transactions)Payment transactions
Array
payPalAdaptiveProfileTransactionsCreatedboolean
transaction_idinteger
dateinteger
publicTxnIdstring
method_namestring
method_local_namestring
statusstring
valuestring
notestring
typestring
public_idstring
order
payment_methodobject
method_idintegerPayment method unique id
service_namestringMethod service name (gateway or API name)
classstringProcess class name
moduleNamestringSpecific module family name
orderbyintegerPosition
adminOrderbyintegerPosition in popup
enabledbooleanEnabled status
addedbooleanAdded status
typestringType
settingsArraySettings
fromMarketplacebooleanFlag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURLstringPayment method icon URL (used for methods from marketplace)
countriesArrayCountries of merchant (merchants from these countries can sign up and use this method)
exCountriesArrayExcluded countries (merchants from these countries cannot sign up for payment account)
countryPositionsArraySettings
dataArray
backend_transactionsArray
currency
currencyobject
currency_idintegerCurrency unique id (ISO 4217 number)
codestringCurrency code (ISO 4217 alpha-3)
symbolstringSymbol
prefixstringPrefix
suffixstringSuffix
estringNumber of digits after the decimal separator.
decimalDelimiterstringDecimal part delimiter
thousandDelimiterstringThousand delimier
ordersArrayOrders
countriesArrayCountries
roundUpstringRoundUp
orderNumberstringUnique order identificator (it is working for orders only, not for cart entities)
recentbooleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExportbooleanFlag to exporting entities
backorderCompetitorsArray of objects (Profiles)Profiles
Array
uspsShipmentArray
capostParcelsArray
capostReturnsArray
capostOffice
mailchimpStoreIdstring
not_finished_order
demoboolean
is_opened_disputeboolean
conversation
childrenArray
parent
vendor
commission
profileTransactionsArray
vendorRatingsArray of objects
Array
idinteger
ratingstring
typestring
additionDateinteger
orderobject
xcPendingExportboolean
usedCouponsArray
reviewKey
order_idinteger
profile
orig_profile
shipping_idinteger
shipping_method_namestring
payment_method_namestring
trackingstring
dateinteger
lastRenewDateinteger
paymentStatusobject
idintegerID
codestringStatus code
positionintegerPosition
shippingStatusobject
idintegerID
codestringStatus code
positionintegerPosition
notesstring
adminNotesstring
detailsArray
trackingNumbersArray
eventsArray
itemsArray
surchargesArray
payment_transactionsArray
currency
orderNumberstring
recentboolean
xcPendingExportboolean
backorderCompetitorsArray
totalstring
subtotalstring
totalstringTotal
subtotalstringSubtotal