Add new cart

Add new cart

Authorizations:Token

Request Body Schema: application/jsonapplication/x-www-form-urlencoded

Cart object that needs to be added

usedCoupons	Array of objects (Used coupons)Used coupons
Array id integer code string value string order coupon type string
uspsShipment	Array of objects (USPS Shipments)USPS Shipments
Array id integer transactionId string order requestData Array responseData Array printDate integer price string shipmentId string trackingNumber string trackingData Array labelURL string labelContent Array
capostParcels	Array of objects (Canada Post parcels (reference to the Canada Post parcels model))Canada Post parcels (reference to the Canada Post parcels model)
Array id integer number integer status string quoteType string order items Array 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	Array of objects (Reference to the Canada Post returns model)Reference to the Canada Post returns model
Array id integer items Array links Array order status string date integer lastRenewDate integer notes string adminNotes string trackingPin string
capostOffice	object
id integerUnique ID order officeId stringThe internal Canada Post assigned unique ID for a Post Office (Field pattern: "\d{10}", has leading zeros) name stringThe name assigned to the Post Office (Max length: 40) location stringThe location of a Post Office. This is used to distinguish among various Post Offices that have similar names. (Max length: 40) distance stringThe distance (in KM) to the Post Office from the location specified in the query (min: 0, max: 99999.99, fraction: 2) bilingualDesignation booleanTrue indicates that the Post Office provides bilingual services (English and French) city stringMunicipality in which the Post Office is located (Max length: 40) latitude stringThe latitude of the Post Office (min: 40, max: 90, fraction: 5) longitude stringThe longitude of the Post Office (min: -150, max: -50, fraction: 5) postalCode stringThe Postal Code of the Post Office province stringThe province where the Post Office is located officeAddress stringStreet number and name for a Post Office (Max length: 64) workingHours ArrayWorking hours list
mailchimpStoreId	stringMailchimp store id
not_finished_order	object
usedCoupons ArrayUsed coupons uspsShipment ArrayUSPS Shipments capostParcels ArrayCanada Post parcels (reference to the Canada Post parcels model) capostReturns ArrayReference to the Canada Post returns model capostOffice mailchimpStoreId stringMailchimp store id not_finished_order demo booleanFlag, if the product participates in the sale exportDate1c integerExport date (1C) reviewKey conversation order_id integerOrder unique id profile orig_profile shipping_id integerShipping method unique id shipping_method_name stringShipping method name payment_method_name stringPayment method name tracking stringShipping tracking code date integerOrder creation timestamp lastRenewDate integerLast order renew date paymentStatus object id integerID code stringStatus code position integerPosition shippingStatus object id integerID code stringStatus code position integerPosition notes stringCustomer notes adminNotes stringAdmin notes details ArrayOrder details trackingNumbers ArrayOrder tracking numbers events ArrayOrder events queue items ArrayOrder items surcharges ArrayOrder surcharges payment_transactions ArrayPayment transactions currency orderNumber stringUnique order identificator (it is working for orders only, not for cart entities) recent booleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false xcPendingExport booleanFlag to exporting entities total stringTotal subtotal stringSubtotal
demo	booleanFlag, if the product participates in the sale
exportDate1c	integerExport date (1C)
reviewKey	object
id integerUnique key ID keyValue stringKey value addedDate integerDate when key was created (UNIX timestamp) sentDate integerDate when key was sent (UNIX timestamp) firstClickDate integerDate when customer first time clicked by link with review key (UNIX timestamp) order reviews ArrayRelation to a profile entity (who adds review)
conversation	object
id integerUnique ID messages ArrayMessages order members ArrayConversation members
order_id	integerOrder unique id
profile	object
socialLoginProvider stringAuth provider (amazon) socialLoginId stringAuth provider-unique user id (for ex. facebook user id) gaClientId stringGoogle analytics cid conciergeUserId string mail_chimp_lists ArrayMailChimp lists mail_chimp_interests ArrayMailChimp lists mail_chimp_segments ArrayMailChimp segments conversations ArrayCoupons profile_id integerProfile unique ID login stringLogin (e-mail) password stringPassword password_hint stringPassword hint password_hint_answer stringPassword hint answer passwordResetKey stringPassword reset key (for 'Forgot password') passwordResetKeyDate integerTimestamp of reset key creation date access_level integerAccess level cms_profile_id integerCMS profile Id cms_name stringCMS name added integerTimestamp of profile creation date first_login integerTimestamp of first login event last_login integerTimestamp of last login event status stringProfile status statusComment stringStatus comment (reason) referer stringReferer order event ArrayRelation to an event language stringLanguage code last_shipping_id integerLast selected shipping id last_payment_id integerLast selected payment id membership object (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table pending_membership object (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table addresses ArrayAddress book: one-to-many relation with address book entity roles ArrayRoles anonymous booleanFlag of anonymous profile (used for checkout process only) forceChangePassword booleanFlag if the user needs to change the password. The customers only dateOfLoginAttempt integerDate of last login attempt countOfLoginAttempts integerCount of login attempt searchFakeField stringFake field for search xcPendingExport booleanFlag to exporting entities lastCheckoutEmail stringCheckout email
orig_profile	object
socialLoginProvider stringAuth provider (amazon) socialLoginId stringAuth provider-unique user id (for ex. facebook user id) gaClientId stringGoogle analytics cid conciergeUserId string mail_chimp_lists ArrayMailChimp lists mail_chimp_interests ArrayMailChimp lists mail_chimp_segments ArrayMailChimp segments conversations ArrayCoupons profile_id integerProfile unique ID login stringLogin (e-mail) password stringPassword password_hint stringPassword hint password_hint_answer stringPassword hint answer passwordResetKey stringPassword reset key (for 'Forgot password') passwordResetKeyDate integerTimestamp of reset key creation date access_level integerAccess level cms_profile_id integerCMS profile Id cms_name stringCMS name added integerTimestamp of profile creation date first_login integerTimestamp of first login event last_login integerTimestamp of last login event status stringProfile status statusComment stringStatus comment (reason) referer stringReferer order event ArrayRelation to an event language stringLanguage code last_shipping_id integerLast selected shipping id last_payment_id integerLast selected payment id membership object (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table pending_membership object (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table addresses ArrayAddress book: one-to-many relation with address book entity roles ArrayRoles anonymous booleanFlag of anonymous profile (used for checkout process only) forceChangePassword booleanFlag if the user needs to change the password. The customers only dateOfLoginAttempt integerDate of last login attempt countOfLoginAttempts integerCount of login attempt searchFakeField stringFake field for search xcPendingExport booleanFlag to exporting entities lastCheckoutEmail stringCheckout email
shipping_id	integerShipping method unique id
shipping_method_name	stringShipping method name
payment_method_name	stringPayment method name
tracking	stringShipping tracking code
date	integerOrder creation timestamp
lastRenewDate	integerLast order renew date
paymentStatus	object
id integerID code stringStatus code position integerPosition
shippingStatus	object
id integerID code stringStatus code position integerPosition
notes	stringCustomer notes
adminNotes	stringAdmin notes
details	Array of objects (Order details)Order details
Array detail_id integer name string label string value string order
trackingNumbers	Array of objects (Order tracking numbers)Order tracking numbers
Array tracking_id integer value string order
events	Array of objects (Order events queue)Order events queue
Array event_id integer date integer code string description string data Array comment string details Array order author authorName string authorIp string
items	Array of objects (Order items)Order items
Array privateAttachments Array categoryAdded string pinCodes Array capostParcelItems Array capostReturnItems Array customerAttachments Array item_id integer object name string sku string price string itemNetPrice string discountedSubtotal string amount integer order surcharges Array attributeValues Array total string subtotal string
surcharges	Array of objects (Order surcharges)Order surcharges
Array owner id integer type string code string class string include boolean available boolean value string name string weight integer
payment_transactions	Array of objects (Payment transactions)Payment transactions
Array 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 payment_method object method_id integerPayment method unique id service_name stringMethod service name (gateway or API name) class stringProcess class name moduleName stringSpecific module family name orderby integerPosition adminOrderby integerPosition in popup enabled booleanEnabled status moduleEnabled booleanModule enabled status added booleanAdded status type stringType settings ArraySettings fromMarketplace booleanFlag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation iconURL stringPayment method icon URL (used for methods from marketplace) countries ArrayCountries of merchant (merchants from these countries can sign up and use this method) exCountries ArrayExcluded countries (merchants from these countries cannot sign up for payment account) data Array backend_transactions Array currency
currency	object
currency_id integerCurrency unique id (ISO 4217 number) code stringCurrency code (ISO 4217 alpha-3) symbol stringSymbol prefix stringPrefix suffix stringSuffix e stringNumber of digits after the decimal separator. decimalDelimiter stringDecimal part delimiter thousandDelimiter stringThousand delimier orders ArrayOrders countries ArrayCountries roundUp stringRoundUp
orderNumber	stringUnique order identificator (it is working for orders only, not for cart entities)
recent	booleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExport	booleanFlag to exporting entities
total	stringTotal
subtotal	stringSubtotal

Responses

200Success

Response schema: application/jsonapplication/xml

Success

usedCoupons	Array of objects (Used coupons)Used coupons
Array id integer code string value string order coupon type string
uspsShipment	Array of objects (USPS Shipments)USPS Shipments
Array id integer transactionId string order requestData Array responseData Array printDate integer price string shipmentId string trackingNumber string trackingData Array labelURL string labelContent Array
capostParcels	Array of objects (Canada Post parcels (reference to the Canada Post parcels model))Canada Post parcels (reference to the Canada Post parcels model)
Array id integer number integer status string quoteType string order items Array 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	Array of objects (Reference to the Canada Post returns model)Reference to the Canada Post returns model
Array id integer items Array links Array order status string date integer lastRenewDate integer notes string adminNotes string trackingPin string
capostOffice	object
id integerUnique ID order officeId stringThe internal Canada Post assigned unique ID for a Post Office (Field pattern: "\d{10}", has leading zeros) name stringThe name assigned to the Post Office (Max length: 40) location stringThe location of a Post Office. This is used to distinguish among various Post Offices that have similar names. (Max length: 40) distance stringThe distance (in KM) to the Post Office from the location specified in the query (min: 0, max: 99999.99, fraction: 2) bilingualDesignation booleanTrue indicates that the Post Office provides bilingual services (English and French) city stringMunicipality in which the Post Office is located (Max length: 40) latitude stringThe latitude of the Post Office (min: 40, max: 90, fraction: 5) longitude stringThe longitude of the Post Office (min: -150, max: -50, fraction: 5) postalCode stringThe Postal Code of the Post Office province stringThe province where the Post Office is located officeAddress stringStreet number and name for a Post Office (Max length: 64) workingHours ArrayWorking hours list
mailchimpStoreId	stringMailchimp store id
not_finished_order	object
usedCoupons ArrayUsed coupons uspsShipment ArrayUSPS Shipments capostParcels ArrayCanada Post parcels (reference to the Canada Post parcels model) capostReturns ArrayReference to the Canada Post returns model capostOffice mailchimpStoreId stringMailchimp store id not_finished_order demo booleanFlag, if the product participates in the sale exportDate1c integerExport date (1C) reviewKey conversation order_id integerOrder unique id profile orig_profile shipping_id integerShipping method unique id shipping_method_name stringShipping method name payment_method_name stringPayment method name tracking stringShipping tracking code date integerOrder creation timestamp lastRenewDate integerLast order renew date paymentStatus object id integerID code stringStatus code position integerPosition shippingStatus object id integerID code stringStatus code position integerPosition notes stringCustomer notes adminNotes stringAdmin notes details ArrayOrder details trackingNumbers ArrayOrder tracking numbers events ArrayOrder events queue items ArrayOrder items surcharges ArrayOrder surcharges payment_transactions ArrayPayment transactions currency orderNumber stringUnique order identificator (it is working for orders only, not for cart entities) recent booleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false xcPendingExport booleanFlag to exporting entities total stringTotal subtotal stringSubtotal
demo	booleanFlag, if the product participates in the sale
exportDate1c	integerExport date (1C)
reviewKey	object
id integerUnique key ID keyValue stringKey value addedDate integerDate when key was created (UNIX timestamp) sentDate integerDate when key was sent (UNIX timestamp) firstClickDate integerDate when customer first time clicked by link with review key (UNIX timestamp) order reviews ArrayRelation to a profile entity (who adds review)
conversation	object
id integerUnique ID messages ArrayMessages order members ArrayConversation members
order_id	integerOrder unique id
profile	object
socialLoginProvider stringAuth provider (amazon) socialLoginId stringAuth provider-unique user id (for ex. facebook user id) gaClientId stringGoogle analytics cid conciergeUserId string mail_chimp_lists ArrayMailChimp lists mail_chimp_interests ArrayMailChimp lists mail_chimp_segments ArrayMailChimp segments conversations ArrayCoupons profile_id integerProfile unique ID login stringLogin (e-mail) password stringPassword password_hint stringPassword hint password_hint_answer stringPassword hint answer passwordResetKey stringPassword reset key (for 'Forgot password') passwordResetKeyDate integerTimestamp of reset key creation date access_level integerAccess level cms_profile_id integerCMS profile Id cms_name stringCMS name added integerTimestamp of profile creation date first_login integerTimestamp of first login event last_login integerTimestamp of last login event status stringProfile status statusComment stringStatus comment (reason) referer stringReferer order event ArrayRelation to an event language stringLanguage code last_shipping_id integerLast selected shipping id last_payment_id integerLast selected payment id membership object (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table pending_membership object (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table addresses ArrayAddress book: one-to-many relation with address book entity roles ArrayRoles anonymous booleanFlag of anonymous profile (used for checkout process only) forceChangePassword booleanFlag if the user needs to change the password. The customers only dateOfLoginAttempt integerDate of last login attempt countOfLoginAttempts integerCount of login attempt searchFakeField stringFake field for search xcPendingExport booleanFlag to exporting entities lastCheckoutEmail stringCheckout email
orig_profile	object
socialLoginProvider stringAuth provider (amazon) socialLoginId stringAuth provider-unique user id (for ex. facebook user id) gaClientId stringGoogle analytics cid conciergeUserId string mail_chimp_lists ArrayMailChimp lists mail_chimp_interests ArrayMailChimp lists mail_chimp_segments ArrayMailChimp segments conversations ArrayCoupons profile_id integerProfile unique ID login stringLogin (e-mail) password stringPassword password_hint stringPassword hint password_hint_answer stringPassword hint answer passwordResetKey stringPassword reset key (for 'Forgot password') passwordResetKeyDate integerTimestamp of reset key creation date access_level integerAccess level cms_profile_id integerCMS profile Id cms_name stringCMS name added integerTimestamp of profile creation date first_login integerTimestamp of first login event last_login integerTimestamp of last login event status stringProfile status statusComment stringStatus comment (reason) referer stringReferer order event ArrayRelation to an event language stringLanguage code last_shipping_id integerLast selected shipping id last_payment_id integerLast selected payment id membership object (Membership: many-to-one relation with memberships table)Membership: many-to-one relation with memberships table pending_membership object (Pending membership: many-to-one relation with memberships table)Pending membership: many-to-one relation with memberships table addresses ArrayAddress book: one-to-many relation with address book entity roles ArrayRoles anonymous booleanFlag of anonymous profile (used for checkout process only) forceChangePassword booleanFlag if the user needs to change the password. The customers only dateOfLoginAttempt integerDate of last login attempt countOfLoginAttempts integerCount of login attempt searchFakeField stringFake field for search xcPendingExport booleanFlag to exporting entities lastCheckoutEmail stringCheckout email
shipping_id	integerShipping method unique id
shipping_method_name	stringShipping method name
payment_method_name	stringPayment method name
tracking	stringShipping tracking code
date	integerOrder creation timestamp
lastRenewDate	integerLast order renew date
paymentStatus	object
id integerID code stringStatus code position integerPosition
shippingStatus	object
id integerID code stringStatus code position integerPosition
notes	stringCustomer notes
adminNotes	stringAdmin notes
details	Array of objects (Order details)Order details
Array detail_id integer name string label string value string order
trackingNumbers	Array of objects (Order tracking numbers)Order tracking numbers
Array tracking_id integer value string order
events	Array of objects (Order events queue)Order events queue
Array event_id integer date integer code string description string data Array comment string details Array order author authorName string authorIp string
items	Array of objects (Order items)Order items
Array privateAttachments Array categoryAdded string pinCodes Array capostParcelItems Array capostReturnItems Array customerAttachments Array item_id integer object name string sku string price string itemNetPrice string discountedSubtotal string amount integer order surcharges Array attributeValues Array total string subtotal string
surcharges	Array of objects (Order surcharges)Order surcharges
Array owner id integer type string code string class string include boolean available boolean value string name string weight integer
payment_transactions	Array of objects (Payment transactions)Payment transactions
Array 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 payment_method object method_id integerPayment method unique id service_name stringMethod service name (gateway or API name) class stringProcess class name moduleName stringSpecific module family name orderby integerPosition adminOrderby integerPosition in popup enabled booleanEnabled status moduleEnabled booleanModule enabled status added booleanAdded status type stringType settings ArraySettings fromMarketplace booleanFlag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation iconURL stringPayment method icon URL (used for methods from marketplace) countries ArrayCountries of merchant (merchants from these countries can sign up and use this method) exCountries ArrayExcluded countries (merchants from these countries cannot sign up for payment account) data Array backend_transactions Array currency
currency	object
currency_id integerCurrency unique id (ISO 4217 number) code stringCurrency code (ISO 4217 alpha-3) symbol stringSymbol prefix stringPrefix suffix stringSuffix e stringNumber of digits after the decimal separator. decimalDelimiter stringDecimal part delimiter thousandDelimiter stringThousand delimier orders ArrayOrders countries ArrayCountries roundUp stringRoundUp
orderNumber	stringUnique order identificator (it is working for orders only, not for cart entities)
recent	booleanRecent flag: true if order's statuses were not changed manually by an administrator, otherwise - false
xcPendingExport	booleanFlag to exporting entities
total	stringTotal
subtotal	stringSubtotal