GET
Retrieve carts by conditions

_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\Cart>[] array
Sample response
[{"usedCoupons":[{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}],"uspsShipment":[{"id":"integer","transactionId":"string","order":"<XLite\\Model\\Order>","requestData":"anything[] array","responseData":"anything[] array","printDate":"integer","price":"string","shipmentId":"string","trackingNumber":"string","trackingData":"anything[] array","labelURL":"string","labelContent":"anything[] array"}],"capostParcels":[{"id":"integer","number":"integer","status":"string","quoteType":"string","order":"<XLite\\Model\\Order>","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","shipment":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Shipment>","boxWeight":"string","boxWidth":"string","boxLength":"string","boxHeight":"string","isDocument":"boolean","isUnpackaged":"boolean","isMailingTube":"boolean","isOversized":"boolean","notifyOnShipment":"boolean","notifyOnException":"boolean","notifyOnDelivery":"boolean","optSignature":"boolean","optCoverage":"string","optAgeProof":"string","optWayToDeliver":"string","optNonDelivery":"string"}],"capostReturns":[{"id":"integer","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","links":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Link>[] array","order":"<XLite\\Model\\Order>","status":"string","date":"integer","lastRenewDate":"integer","notes":"string","adminNotes":"string","trackingPin":"string"}],"capostOffice":{"id":"integer","order":"<XLite\\Model\\Order>","officeId":"string","name":"string","location":"string","distance":"string","bilingualDesignation":"boolean","city":"string","latitude":"string","longitude":"string","postalCode":"string","province":"string","officeAddress":"string","workingHours":"anything[] array"},"giftWrapping":true,"greetingMessage":"example","mailchimpStoreId":"example","mandrill_mails":[{"mail_id":"string","opened":"boolean","clicked":"boolean","ip":"string","country_short":"string","mobile":"boolean","os_family":"string","ua_family":"string","order":"<XLite\\Model\\Order>"}],"not_finished_order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"pbOrder":{"id":"integer","ormus":"string","transactionId":"string","order":"<XLite\\Model\\Order>","parcels":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBParcel>[] array","createOrderResponse":"<createOrderResponse object>"},"conversation":{"id":"integer","messages":"<XLite\\Module\\XC\\VendorMessages\\Model\\Message>[] array","order":"<XLite\\Model\\Order>","members":"<XLite\\Model\\Profile>[] array"},"order_id":53,"profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"orig_profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"shipping_id":81,"shipping_method_name":"example","payment_method_name":"example","tracking":"example","date":68,"lastRenewDate":39,"paymentStatus":{"id":"integer","code":"string","position":"integer"},"shippingStatus":{"id":"integer","code":"string","position":"integer"},"notes":"example","adminNotes":"example","details":[{"detail_id":"integer","name":"string","label":"string","value":"string","order":"<XLite\\Model\\Order>"}],"trackingNumbers":[{"tracking_id":"integer","value":"string","order":"<XLite\\Model\\Order>"}],"events":[{"event_id":"integer","date":"integer","code":"string","description":"string","data":"anything[] array","comment":"string","details":"<XLite\\Model\\OrderHistoryEventsData>[] array","order":"<XLite\\Model\\Order>","author":"<XLite\\Model\\Profile>"}],"items":[{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"}],"surcharges":[{"owner":"<XLite\\Model\\Order>","id":"integer","type":"string","code":"string","class":"string","include":"boolean","available":"boolean","value":"string","name":"string","weight":"integer"}],"payment_transactions":[{"transaction_id":"integer","date":"integer","publicTxnId":"string","method_name":"string","method_local_name":"string","status":"string","value":"string","note":"string","type":"string","public_id":"string","order":"<XLite\\Model\\Order>","payment_method":"<XLite\\Model\\Payment\\Method>","data":"<XLite\\Model\\Payment\\TransactionData>[] array","backend_transactions":"<XLite\\Model\\Payment\\BackendTransaction>[] array","currency":"<XLite\\Model\\Currency>"}],"currency":{"currency_id":"integer","code":"string","symbol":"string","prefix":"string","suffix":"string","e":"string","decimalDelimiter":"string","thousandDelimiter":"string","orders":"<XLite\\Model\\Order>[] array","countries":"<XLite\\Model\\Country>[] array"},"orderNumber":"example","recent":true,"xcPendingExport":false,"total":"example","subtotal":"example"}]

GET
Retrieve cart by id

id
integer Required
Id value of the Cart object
default Success <XLite\Model\Cart>
Sample response
{"usedCoupons":[{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}],"uspsShipment":[{"id":"integer","transactionId":"string","order":"<XLite\\Model\\Order>","requestData":"anything[] array","responseData":"anything[] array","printDate":"integer","price":"string","shipmentId":"string","trackingNumber":"string","trackingData":"anything[] array","labelURL":"string","labelContent":"anything[] array"}],"capostParcels":[{"id":"integer","number":"integer","status":"string","quoteType":"string","order":"<XLite\\Model\\Order>","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","shipment":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Shipment>","boxWeight":"string","boxWidth":"string","boxLength":"string","boxHeight":"string","isDocument":"boolean","isUnpackaged":"boolean","isMailingTube":"boolean","isOversized":"boolean","notifyOnShipment":"boolean","notifyOnException":"boolean","notifyOnDelivery":"boolean","optSignature":"boolean","optCoverage":"string","optAgeProof":"string","optWayToDeliver":"string","optNonDelivery":"string"}],"capostReturns":[{"id":"integer","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","links":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Link>[] array","order":"<XLite\\Model\\Order>","status":"string","date":"integer","lastRenewDate":"integer","notes":"string","adminNotes":"string","trackingPin":"string"}],"capostOffice":{"id":"integer","order":"<XLite\\Model\\Order>","officeId":"string","name":"string","location":"string","distance":"string","bilingualDesignation":"boolean","city":"string","latitude":"string","longitude":"string","postalCode":"string","province":"string","officeAddress":"string","workingHours":"anything[] array"},"giftWrapping":true,"greetingMessage":"example","mailchimpStoreId":"example","mandrill_mails":[{"mail_id":"string","opened":"boolean","clicked":"boolean","ip":"string","country_short":"string","mobile":"boolean","os_family":"string","ua_family":"string","order":"<XLite\\Model\\Order>"}],"not_finished_order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"pbOrder":{"id":"integer","ormus":"string","transactionId":"string","order":"<XLite\\Model\\Order>","parcels":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBParcel>[] array","createOrderResponse":"<createOrderResponse object>"},"conversation":{"id":"integer","messages":"<XLite\\Module\\XC\\VendorMessages\\Model\\Message>[] array","order":"<XLite\\Model\\Order>","members":"<XLite\\Model\\Profile>[] array"},"order_id":53,"profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"orig_profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"shipping_id":81,"shipping_method_name":"example","payment_method_name":"example","tracking":"example","date":68,"lastRenewDate":39,"paymentStatus":{"id":"integer","code":"string","position":"integer"},"shippingStatus":{"id":"integer","code":"string","position":"integer"},"notes":"example","adminNotes":"example","details":[{"detail_id":"integer","name":"string","label":"string","value":"string","order":"<XLite\\Model\\Order>"}],"trackingNumbers":[{"tracking_id":"integer","value":"string","order":"<XLite\\Model\\Order>"}],"events":[{"event_id":"integer","date":"integer","code":"string","description":"string","data":"anything[] array","comment":"string","details":"<XLite\\Model\\OrderHistoryEventsData>[] array","order":"<XLite\\Model\\Order>","author":"<XLite\\Model\\Profile>"}],"items":[{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"}],"surcharges":[{"owner":"<XLite\\Model\\Order>","id":"integer","type":"string","code":"string","class":"string","include":"boolean","available":"boolean","value":"string","name":"string","weight":"integer"}],"payment_transactions":[{"transaction_id":"integer","date":"integer","publicTxnId":"string","method_name":"string","method_local_name":"string","status":"string","value":"string","note":"string","type":"string","public_id":"string","order":"<XLite\\Model\\Order>","payment_method":"<XLite\\Model\\Payment\\Method>","data":"<XLite\\Model\\Payment\\TransactionData>[] array","backend_transactions":"<XLite\\Model\\Payment\\BackendTransaction>[] array","currency":"<XLite\\Model\\Currency>"}],"currency":{"currency_id":"integer","code":"string","symbol":"string","prefix":"string","suffix":"string","e":"string","decimalDelimiter":"string","thousandDelimiter":"string","orders":"<XLite\\Model\\Order>[] array","countries":"<XLite\\Model\\Country>[] array"},"orderNumber":"example","recent":true,"xcPendingExport":false,"total":"example","subtotal":"example"}
usedCoupons
[] array
Used coupons
uspsShipment
[] array
USPS Shipments
capostParcels
[] array
Canada Post parcels (reference to the Canada Post parcels model)
capostReturns
[] array
Reference to the Canada Post returns model
capostOffice
giftWrapping
boolean
greetingMessage
string
mailchimpStoreId
string
Mailchimp store id
mandrill_mails
[] array
Mandrill e-mail messages
not_finished_order
pbOrder
conversation
order_id
integer
Order unique id
profile
orig_profile
shipping_id
integer
Shipping method unique id
shipping_method_name
string
Shipping method name
payment_method_name
string
Payment method name
tracking
string
Shipping tracking code
date
integer
Order creation timestamp
lastRenewDate
integer
Last order renew date
paymentStatus
shippingStatus
notes
string
Customer notes
adminNotes
string
Admin notes
details
[] array
Order details
trackingNumbers
[] array
Order tracking numbers
events
[] array
Order events queue
items
[] array
Order items
surcharges
[] array
Order surcharges
payment_transactions
[] array
Payment transactions
currency
orderNumber
string
Unique order identificator (it is working for orders only, not for cart entities)
recent
boolean
Recent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExport
boolean
Flag to exporting entities
total
string
Total
subtotal
string
Subtotal

PUT
Update cart by id

id
integer Required
Id value of the Cart object
<XLite\Model\Cart>
usedCoupons
[] array
Used coupons
uspsShipment
[] array
USPS Shipments
capostParcels
[] array
Canada Post parcels (reference to the Canada Post parcels model)
capostReturns
[] array
Reference to the Canada Post returns model
capostOffice
giftWrapping
boolean
greetingMessage
string
mailchimpStoreId
string
Mailchimp store id
mandrill_mails
[] array
Mandrill e-mail messages
not_finished_order
pbOrder
conversation
order_id
integer
Order unique id
profile
orig_profile
shipping_id
integer
Shipping method unique id
shipping_method_name
string
Shipping method name
payment_method_name
string
Payment method name
tracking
string
Shipping tracking code
date
integer
Order creation timestamp
lastRenewDate
integer
Last order renew date
paymentStatus
shippingStatus
notes
string
Customer notes
adminNotes
string
Admin notes
details
[] array
Order details
trackingNumbers
[] array
Order tracking numbers
events
[] array
Order events queue
items
[] array
Order items
surcharges
[] array
Order surcharges
payment_transactions
[] array
Payment transactions
currency
orderNumber
string
Unique order identificator (it is working for orders only, not for cart entities)
recent
boolean
Recent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExport
boolean
Flag to exporting entities
total
string
Total
subtotal
string
Subtotal
default Success <XLite\Model\Cart>
Sample response
{"usedCoupons":[{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}],"uspsShipment":[{"id":"integer","transactionId":"string","order":"<XLite\\Model\\Order>","requestData":"anything[] array","responseData":"anything[] array","printDate":"integer","price":"string","shipmentId":"string","trackingNumber":"string","trackingData":"anything[] array","labelURL":"string","labelContent":"anything[] array"}],"capostParcels":[{"id":"integer","number":"integer","status":"string","quoteType":"string","order":"<XLite\\Model\\Order>","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","shipment":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Shipment>","boxWeight":"string","boxWidth":"string","boxLength":"string","boxHeight":"string","isDocument":"boolean","isUnpackaged":"boolean","isMailingTube":"boolean","isOversized":"boolean","notifyOnShipment":"boolean","notifyOnException":"boolean","notifyOnDelivery":"boolean","optSignature":"boolean","optCoverage":"string","optAgeProof":"string","optWayToDeliver":"string","optNonDelivery":"string"}],"capostReturns":[{"id":"integer","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","links":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Link>[] array","order":"<XLite\\Model\\Order>","status":"string","date":"integer","lastRenewDate":"integer","notes":"string","adminNotes":"string","trackingPin":"string"}],"capostOffice":{"id":"integer","order":"<XLite\\Model\\Order>","officeId":"string","name":"string","location":"string","distance":"string","bilingualDesignation":"boolean","city":"string","latitude":"string","longitude":"string","postalCode":"string","province":"string","officeAddress":"string","workingHours":"anything[] array"},"giftWrapping":true,"greetingMessage":"example","mailchimpStoreId":"example","mandrill_mails":[{"mail_id":"string","opened":"boolean","clicked":"boolean","ip":"string","country_short":"string","mobile":"boolean","os_family":"string","ua_family":"string","order":"<XLite\\Model\\Order>"}],"not_finished_order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"pbOrder":{"id":"integer","ormus":"string","transactionId":"string","order":"<XLite\\Model\\Order>","parcels":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBParcel>[] array","createOrderResponse":"<createOrderResponse object>"},"conversation":{"id":"integer","messages":"<XLite\\Module\\XC\\VendorMessages\\Model\\Message>[] array","order":"<XLite\\Model\\Order>","members":"<XLite\\Model\\Profile>[] array"},"order_id":53,"profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"orig_profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"shipping_id":81,"shipping_method_name":"example","payment_method_name":"example","tracking":"example","date":68,"lastRenewDate":39,"paymentStatus":{"id":"integer","code":"string","position":"integer"},"shippingStatus":{"id":"integer","code":"string","position":"integer"},"notes":"example","adminNotes":"example","details":[{"detail_id":"integer","name":"string","label":"string","value":"string","order":"<XLite\\Model\\Order>"}],"trackingNumbers":[{"tracking_id":"integer","value":"string","order":"<XLite\\Model\\Order>"}],"events":[{"event_id":"integer","date":"integer","code":"string","description":"string","data":"anything[] array","comment":"string","details":"<XLite\\Model\\OrderHistoryEventsData>[] array","order":"<XLite\\Model\\Order>","author":"<XLite\\Model\\Profile>"}],"items":[{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"}],"surcharges":[{"owner":"<XLite\\Model\\Order>","id":"integer","type":"string","code":"string","class":"string","include":"boolean","available":"boolean","value":"string","name":"string","weight":"integer"}],"payment_transactions":[{"transaction_id":"integer","date":"integer","publicTxnId":"string","method_name":"string","method_local_name":"string","status":"string","value":"string","note":"string","type":"string","public_id":"string","order":"<XLite\\Model\\Order>","payment_method":"<XLite\\Model\\Payment\\Method>","data":"<XLite\\Model\\Payment\\TransactionData>[] array","backend_transactions":"<XLite\\Model\\Payment\\BackendTransaction>[] array","currency":"<XLite\\Model\\Currency>"}],"currency":{"currency_id":"integer","code":"string","symbol":"string","prefix":"string","suffix":"string","e":"string","decimalDelimiter":"string","thousandDelimiter":"string","orders":"<XLite\\Model\\Order>[] array","countries":"<XLite\\Model\\Country>[] array"},"orderNumber":"example","recent":true,"xcPendingExport":false,"total":"example","subtotal":"example"}
usedCoupons
[] array
Used coupons
uspsShipment
[] array
USPS Shipments
capostParcels
[] array
Canada Post parcels (reference to the Canada Post parcels model)
capostReturns
[] array
Reference to the Canada Post returns model
capostOffice
giftWrapping
boolean
greetingMessage
string
mailchimpStoreId
string
Mailchimp store id
mandrill_mails
[] array
Mandrill e-mail messages
not_finished_order
pbOrder
conversation
order_id
integer
Order unique id
profile
orig_profile
shipping_id
integer
Shipping method unique id
shipping_method_name
string
Shipping method name
payment_method_name
string
Payment method name
tracking
string
Shipping tracking code
date
integer
Order creation timestamp
lastRenewDate
integer
Last order renew date
paymentStatus
shippingStatus
notes
string
Customer notes
adminNotes
string
Admin notes
details
[] array
Order details
trackingNumbers
[] array
Order tracking numbers
events
[] array
Order events queue
items
[] array
Order items
surcharges
[] array
Order surcharges
payment_transactions
[] array
Payment transactions
currency
orderNumber
string
Unique order identificator (it is working for orders only, not for cart entities)
recent
boolean
Recent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExport
boolean
Flag to exporting entities
total
string
Total
subtotal
string
Subtotal

DELETE
Delete cart by id

id
integer Required
Id value of the Cart object
default Success <XLite\Model\Cart>
Sample response
{"usedCoupons":[{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}],"uspsShipment":[{"id":"integer","transactionId":"string","order":"<XLite\\Model\\Order>","requestData":"anything[] array","responseData":"anything[] array","printDate":"integer","price":"string","shipmentId":"string","trackingNumber":"string","trackingData":"anything[] array","labelURL":"string","labelContent":"anything[] array"}],"capostParcels":[{"id":"integer","number":"integer","status":"string","quoteType":"string","order":"<XLite\\Model\\Order>","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","shipment":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Shipment>","boxWeight":"string","boxWidth":"string","boxLength":"string","boxHeight":"string","isDocument":"boolean","isUnpackaged":"boolean","isMailingTube":"boolean","isOversized":"boolean","notifyOnShipment":"boolean","notifyOnException":"boolean","notifyOnDelivery":"boolean","optSignature":"boolean","optCoverage":"string","optAgeProof":"string","optWayToDeliver":"string","optNonDelivery":"string"}],"capostReturns":[{"id":"integer","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","links":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Link>[] array","order":"<XLite\\Model\\Order>","status":"string","date":"integer","lastRenewDate":"integer","notes":"string","adminNotes":"string","trackingPin":"string"}],"capostOffice":{"id":"integer","order":"<XLite\\Model\\Order>","officeId":"string","name":"string","location":"string","distance":"string","bilingualDesignation":"boolean","city":"string","latitude":"string","longitude":"string","postalCode":"string","province":"string","officeAddress":"string","workingHours":"anything[] array"},"giftWrapping":true,"greetingMessage":"example","mailchimpStoreId":"example","mandrill_mails":[{"mail_id":"string","opened":"boolean","clicked":"boolean","ip":"string","country_short":"string","mobile":"boolean","os_family":"string","ua_family":"string","order":"<XLite\\Model\\Order>"}],"not_finished_order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"pbOrder":{"id":"integer","ormus":"string","transactionId":"string","order":"<XLite\\Model\\Order>","parcels":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBParcel>[] array","createOrderResponse":"<createOrderResponse object>"},"conversation":{"id":"integer","messages":"<XLite\\Module\\XC\\VendorMessages\\Model\\Message>[] array","order":"<XLite\\Model\\Order>","members":"<XLite\\Model\\Profile>[] array"},"order_id":53,"profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"orig_profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"shipping_id":81,"shipping_method_name":"example","payment_method_name":"example","tracking":"example","date":68,"lastRenewDate":39,"paymentStatus":{"id":"integer","code":"string","position":"integer"},"shippingStatus":{"id":"integer","code":"string","position":"integer"},"notes":"example","adminNotes":"example","details":[{"detail_id":"integer","name":"string","label":"string","value":"string","order":"<XLite\\Model\\Order>"}],"trackingNumbers":[{"tracking_id":"integer","value":"string","order":"<XLite\\Model\\Order>"}],"events":[{"event_id":"integer","date":"integer","code":"string","description":"string","data":"anything[] array","comment":"string","details":"<XLite\\Model\\OrderHistoryEventsData>[] array","order":"<XLite\\Model\\Order>","author":"<XLite\\Model\\Profile>"}],"items":[{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"}],"surcharges":[{"owner":"<XLite\\Model\\Order>","id":"integer","type":"string","code":"string","class":"string","include":"boolean","available":"boolean","value":"string","name":"string","weight":"integer"}],"payment_transactions":[{"transaction_id":"integer","date":"integer","publicTxnId":"string","method_name":"string","method_local_name":"string","status":"string","value":"string","note":"string","type":"string","public_id":"string","order":"<XLite\\Model\\Order>","payment_method":"<XLite\\Model\\Payment\\Method>","data":"<XLite\\Model\\Payment\\TransactionData>[] array","backend_transactions":"<XLite\\Model\\Payment\\BackendTransaction>[] array","currency":"<XLite\\Model\\Currency>"}],"currency":{"currency_id":"integer","code":"string","symbol":"string","prefix":"string","suffix":"string","e":"string","decimalDelimiter":"string","thousandDelimiter":"string","orders":"<XLite\\Model\\Order>[] array","countries":"<XLite\\Model\\Country>[] array"},"orderNumber":"example","recent":true,"xcPendingExport":false,"total":"example","subtotal":"example"}
usedCoupons
[] array
Used coupons
uspsShipment
[] array
USPS Shipments
capostParcels
[] array
Canada Post parcels (reference to the Canada Post parcels model)
capostReturns
[] array
Reference to the Canada Post returns model
capostOffice
giftWrapping
boolean
greetingMessage
string
mailchimpStoreId
string
Mailchimp store id
mandrill_mails
[] array
Mandrill e-mail messages
not_finished_order
pbOrder
conversation
order_id
integer
Order unique id
profile
orig_profile
shipping_id
integer
Shipping method unique id
shipping_method_name
string
Shipping method name
payment_method_name
string
Payment method name
tracking
string
Shipping tracking code
date
integer
Order creation timestamp
lastRenewDate
integer
Last order renew date
paymentStatus
shippingStatus
notes
string
Customer notes
adminNotes
string
Admin notes
details
[] array
Order details
trackingNumbers
[] array
Order tracking numbers
events
[] array
Order events queue
items
[] array
Order items
surcharges
[] array
Order surcharges
payment_transactions
[] array
Payment transactions
currency
orderNumber
string
Unique order identificator (it is working for orders only, not for cart entities)
recent
boolean
Recent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExport
boolean
Flag to exporting entities
total
string
Total
subtotal
string
Subtotal

POST
Add new cart

<XLite\Model\Cart>
usedCoupons
[] array
Used coupons
uspsShipment
[] array
USPS Shipments
capostParcels
[] array
Canada Post parcels (reference to the Canada Post parcels model)
capostReturns
[] array
Reference to the Canada Post returns model
capostOffice
giftWrapping
boolean
greetingMessage
string
mailchimpStoreId
string
Mailchimp store id
mandrill_mails
[] array
Mandrill e-mail messages
not_finished_order
pbOrder
conversation
order_id
integer
Order unique id
profile
orig_profile
shipping_id
integer
Shipping method unique id
shipping_method_name
string
Shipping method name
payment_method_name
string
Payment method name
tracking
string
Shipping tracking code
date
integer
Order creation timestamp
lastRenewDate
integer
Last order renew date
paymentStatus
shippingStatus
notes
string
Customer notes
adminNotes
string
Admin notes
details
[] array
Order details
trackingNumbers
[] array
Order tracking numbers
events
[] array
Order events queue
items
[] array
Order items
surcharges
[] array
Order surcharges
payment_transactions
[] array
Payment transactions
currency
orderNumber
string
Unique order identificator (it is working for orders only, not for cart entities)
recent
boolean
Recent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExport
boolean
Flag to exporting entities
total
string
Total
subtotal
string
Subtotal
default Success <XLite\Model\Cart>
Sample response
{"usedCoupons":[{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}],"uspsShipment":[{"id":"integer","transactionId":"string","order":"<XLite\\Model\\Order>","requestData":"anything[] array","responseData":"anything[] array","printDate":"integer","price":"string","shipmentId":"string","trackingNumber":"string","trackingData":"anything[] array","labelURL":"string","labelContent":"anything[] array"}],"capostParcels":[{"id":"integer","number":"integer","status":"string","quoteType":"string","order":"<XLite\\Model\\Order>","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","shipment":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Shipment>","boxWeight":"string","boxWidth":"string","boxLength":"string","boxHeight":"string","isDocument":"boolean","isUnpackaged":"boolean","isMailingTube":"boolean","isOversized":"boolean","notifyOnShipment":"boolean","notifyOnException":"boolean","notifyOnDelivery":"boolean","optSignature":"boolean","optCoverage":"string","optAgeProof":"string","optWayToDeliver":"string","optNonDelivery":"string"}],"capostReturns":[{"id":"integer","items":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","links":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Link>[] array","order":"<XLite\\Model\\Order>","status":"string","date":"integer","lastRenewDate":"integer","notes":"string","adminNotes":"string","trackingPin":"string"}],"capostOffice":{"id":"integer","order":"<XLite\\Model\\Order>","officeId":"string","name":"string","location":"string","distance":"string","bilingualDesignation":"boolean","city":"string","latitude":"string","longitude":"string","postalCode":"string","province":"string","officeAddress":"string","workingHours":"anything[] array"},"giftWrapping":true,"greetingMessage":"example","mailchimpStoreId":"example","mandrill_mails":[{"mail_id":"string","opened":"boolean","clicked":"boolean","ip":"string","country_short":"string","mobile":"boolean","os_family":"string","ua_family":"string","order":"<XLite\\Model\\Order>"}],"not_finished_order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"pbOrder":{"id":"integer","ormus":"string","transactionId":"string","order":"<XLite\\Model\\Order>","parcels":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBParcel>[] array","createOrderResponse":"<createOrderResponse object>"},"conversation":{"id":"integer","messages":"<XLite\\Module\\XC\\VendorMessages\\Model\\Message>[] array","order":"<XLite\\Model\\Order>","members":"<XLite\\Model\\Profile>[] array"},"order_id":53,"profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"orig_profile":{"gaClientId":"string","socialLoginProvider":"string","socialLoginId":"string","pictureUrl":"string","mail_chimp_lists":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>[] array","mail_chimp_interests":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpGroupName>[] array","mail_chimp_segments":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpSegment>[] array","auth_phone_number":"string","auth_phone_code":"string","authy_id":"integer","conversations":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>[] array","profile_id":"integer","login":"string","password":"string","password_hint":"string","password_hint_answer":"string","passwordResetKey":"string","passwordResetKeyDate":"integer","access_level":"integer","cms_profile_id":"integer","cms_name":"string","added":"integer","first_login":"integer","last_login":"integer","status":"string","statusComment":"string","referer":"string","order":"<XLite\\Model\\Order>","event":"<XLite\\Model\\OrderHistoryEvents>[] array","language":"string","last_shipping_id":"integer","last_payment_id":"integer","membership":"<membership object>","pending_membership":"<pending_membership object>","addresses":"<XLite\\Model\\Address>[] array","roles":"<XLite\\Model\\Role>[] array","anonymous":"boolean","forceChangePassword":"boolean","dateOfLoginAttempt":"integer","countOfLoginAttempts":"integer","searchFakeField":"string","xcPendingExport":"boolean"},"shipping_id":81,"shipping_method_name":"example","payment_method_name":"example","tracking":"example","date":68,"lastRenewDate":39,"paymentStatus":{"id":"integer","code":"string","position":"integer"},"shippingStatus":{"id":"integer","code":"string","position":"integer"},"notes":"example","adminNotes":"example","details":[{"detail_id":"integer","name":"string","label":"string","value":"string","order":"<XLite\\Model\\Order>"}],"trackingNumbers":[{"tracking_id":"integer","value":"string","order":"<XLite\\Model\\Order>"}],"events":[{"event_id":"integer","date":"integer","code":"string","description":"string","data":"anything[] array","comment":"string","details":"<XLite\\Model\\OrderHistoryEventsData>[] array","order":"<XLite\\Model\\Order>","author":"<XLite\\Model\\Profile>"}],"items":[{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"}],"surcharges":[{"owner":"<XLite\\Model\\Order>","id":"integer","type":"string","code":"string","class":"string","include":"boolean","available":"boolean","value":"string","name":"string","weight":"integer"}],"payment_transactions":[{"transaction_id":"integer","date":"integer","publicTxnId":"string","method_name":"string","method_local_name":"string","status":"string","value":"string","note":"string","type":"string","public_id":"string","order":"<XLite\\Model\\Order>","payment_method":"<XLite\\Model\\Payment\\Method>","data":"<XLite\\Model\\Payment\\TransactionData>[] array","backend_transactions":"<XLite\\Model\\Payment\\BackendTransaction>[] array","currency":"<XLite\\Model\\Currency>"}],"currency":{"currency_id":"integer","code":"string","symbol":"string","prefix":"string","suffix":"string","e":"string","decimalDelimiter":"string","thousandDelimiter":"string","orders":"<XLite\\Model\\Order>[] array","countries":"<XLite\\Model\\Country>[] array"},"orderNumber":"example","recent":true,"xcPendingExport":false,"total":"example","subtotal":"example"}
usedCoupons
[] array
Used coupons
uspsShipment
[] array
USPS Shipments
capostParcels
[] array
Canada Post parcels (reference to the Canada Post parcels model)
capostReturns
[] array
Reference to the Canada Post returns model
capostOffice
giftWrapping
boolean
greetingMessage
string
mailchimpStoreId
string
Mailchimp store id
mandrill_mails
[] array
Mandrill e-mail messages
not_finished_order
pbOrder
conversation
order_id
integer
Order unique id
profile
orig_profile
shipping_id
integer
Shipping method unique id
shipping_method_name
string
Shipping method name
payment_method_name
string
Payment method name
tracking
string
Shipping tracking code
date
integer
Order creation timestamp
lastRenewDate
integer
Last order renew date
paymentStatus
shippingStatus
notes
string
Customer notes
adminNotes
string
Admin notes
details
[] array
Order details
trackingNumbers
[] array
Order tracking numbers
events
[] array
Order events queue
items
[] array
Order items
surcharges
[] array
Order surcharges
payment_transactions
[] array
Payment transactions
currency
orderNumber
string
Unique order identificator (it is working for orders only, not for cart entities)
recent
boolean
Recent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExport
boolean
Flag to exporting entities
total
string
Total
subtotal
string
Subtotal