MailChimpSegment repo

GET
Retrieve mailchimp segments 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\Module\XC\MailChimp\Model\MailChimpSegment>[] array
Sample response
[{"id":"example","name":"example","created_date":"example","static":false,"list":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>","useOrdersLastMonth":true,"ordersLastMonth":75,"useOrderAmount":false,"orderAmount":"example","useMemberships":true,"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"useProducts":false,"products":[{"featuredProducts":"<XLite\\Module\\CDev\\FeaturedProducts\\Model\\FeaturedProduct>[] array","attachments":"<XLite\\Module\\CDev\\FileAttachments\\Model\\Product\\Attachment>[] array","ogMeta":"string","useCustomOG":"boolean","marketPrice":"string","pinCodesEnabled":"boolean","autoPinCodes":"boolean","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","views_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","purchase_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","participateSale":"boolean","discountType":"string","salePriceValue":"string","xcPendingBulkEdit":"boolean","tabs":"<XLite\\Module\\XC\\CustomProductTabs\\Model\\Product\\Tab>[] array","isCustomerAttachmentsAvailable":"boolean","isCustomerAttachmentsRequired":"boolean","facebookMarketingEnabled":"boolean","freeShip":"boolean","freightFixedFee":"string","useAsSegmentCondition":"boolean","exported_pb":"boolean","gpc":"string","gtin":"string","hs_code":"string","mpn":"string","model_number":"string","stock_number":"string","hazmat":"boolean","chemicals":"boolean","pesticide":"boolean","aerosol":"boolean","rppc":"boolean","non_spillable":"boolean","fuel":"boolean","ormd":"boolean","battery":"string","product_condition":"string","country_of_origin":"<XLite\\Model\\Country>","restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","tags":"<XLite\\Module\\XC\\ProductTags\\Model\\Tag>[] array","variants":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>[] array","variantsAttributes":"<XLite\\Model\\Attribute>[] array","wholesalePrices":"<XLite\\Module\\CDev\\Wholesale\\Model\\WholesalePrice>[] array","reviews":"<XLite\\Module\\XC\\Reviews\\Model\\Review>[] array","upsellingProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","upsellingParentProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","product_id":"integer","price":"string","sku":"string","enabled":"boolean","weight":"string","useSeparateBox":"boolean","boxWidth":"string","boxLength":"string","boxHeight":"string","itemsPerBox":"integer","free_shipping":"boolean","taxable":"boolean","javascript":"string","arrivalDate":"integer","date":"integer","updateDate":"integer","needProcess":"boolean","categoryProducts":"<XLite\\Model\\CategoryProducts>[] array","order_items":"<XLite\\Model\\OrderItem>[] array","images":"<XLite\\Model\\Image\\Product\\Image>[] array","inventoryEnabled":"boolean","amount":"integer","lowLimitEnabledCustomer":"boolean","lowLimitEnabled":"boolean","lowLimitAmount":"integer","productClass":"<XLite\\Model\\ProductClass>","taxClass":"<XLite\\Model\\TaxClass>","attributes":"<XLite\\Model\\Attribute>[] array","attributeValueC":"<XLite\\Model\\AttributeValue\\AttributeValueCheckbox>[] array","attributeValueT":"<XLite\\Model\\AttributeValue\\AttributeValueText>[] array","attributeValueS":"<XLite\\Model\\AttributeValue\\AttributeValueSelect>[] array","attrSepTab":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","memberships":"<XLite\\Model\\Membership>[] array","cleanURLs":"<XLite\\Model\\CleanURL>[] array","metaDescType":"string","sales":"integer","xcPendingExport":"boolean"}],"profiles":[{"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"}],"enabled":false}]

GET
Retrieve mailchimp segment by id

id
integer Required
Id value of the MailChimpSegment object
default Success <XLite\Module\XC\MailChimp\Model\MailChimpSegment>
Sample response
{"id":"example","name":"example","created_date":"example","static":false,"list":"<XLite\\Module\\XC\\MailChimp\\Model\\MailChimpList>","useOrdersLastMonth":true,"ordersLastMonth":75,"useOrderAmount":false,"orderAmount":"example","useMemberships":true,"memberships":[{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}],"useProducts":false,"products":[{"featuredProducts":"<XLite\\Module\\CDev\\FeaturedProducts\\Model\\FeaturedProduct>[] array","attachments":"<XLite\\Module\\CDev\\FileAttachments\\Model\\Product\\Attachment>[] array","ogMeta":"string","useCustomOG":"boolean","marketPrice":"string","pinCodesEnabled":"boolean","autoPinCodes":"boolean","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","views_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","purchase_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","participateSale":"boolean","discountType":"string","salePriceValue":"string","xcPendingBulkEdit":"boolean","tabs":"<XLite\\Module\\XC\\CustomProductTabs\\Model\\Product\\Tab>[] array","isCustomerAttachmentsAvailable":"boolean","isCustomerAttachmentsRequired":"boolean","facebookMarketingEnabled":"boolean","freeShip":"boolean","freightFixedFee":"string","useAsSegmentCondition":"boolean","exported_pb":"boolean","gpc":"string","gtin":"string","hs_code":"string","mpn":"string","model_number":"string","stock_number":"string","hazmat":"boolean","chemicals":"boolean","pesticide":"boolean","aerosol":"boolean","rppc":"boolean","non_spillable":"boolean","fuel":"boolean","ormd":"boolean","battery":"string","product_condition":"string","country_of_origin":"<XLite\\Model\\Country>","restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","tags":"<XLite\\Module\\XC\\ProductTags\\Model\\Tag>[] array","variants":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>[] array","variantsAttributes":"<XLite\\Model\\Attribute>[] array","wholesalePrices":"<XLite\\Module\\CDev\\Wholesale\\Model\\WholesalePrice>[] array","reviews":"<XLite\\Module\\XC\\Reviews\\Model\\Review>[] array","upsellingProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","upsellingParentProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","product_id":"integer","price":"string","sku":"string","enabled":"boolean","weight":"string","useSeparateBox":"boolean","boxWidth":"string","boxLength":"string","boxHeight":"string","itemsPerBox":"integer","free_shipping":"boolean","taxable":"boolean","javascript":"string","arrivalDate":"integer","date":"integer","updateDate":"integer","needProcess":"boolean","categoryProducts":"<XLite\\Model\\CategoryProducts>[] array","order_items":"<XLite\\Model\\OrderItem>[] array","images":"<XLite\\Model\\Image\\Product\\Image>[] array","inventoryEnabled":"boolean","amount":"integer","lowLimitEnabledCustomer":"boolean","lowLimitEnabled":"boolean","lowLimitAmount":"integer","productClass":"<XLite\\Model\\ProductClass>","taxClass":"<XLite\\Model\\TaxClass>","attributes":"<XLite\\Model\\Attribute>[] array","attributeValueC":"<XLite\\Model\\AttributeValue\\AttributeValueCheckbox>[] array","attributeValueT":"<XLite\\Model\\AttributeValue\\AttributeValueText>[] array","attributeValueS":"<XLite\\Model\\AttributeValue\\AttributeValueSelect>[] array","attrSepTab":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","memberships":"<XLite\\Model\\Membership>[] array","cleanURLs":"<XLite\\Model\\CleanURL>[] array","metaDescType":"string","sales":"integer","xcPendingExport":"boolean"}],"profiles":[{"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"}],"enabled":false}
id
string
List ID
name
string
List name
created_date
string
List creation date
static
boolean
Is static MailChimp segment
list
useOrdersLastMonth
boolean
Use amount of orders as condition
ordersLastMonth
integer
Amount of orders last month
useOrderAmount
boolean
Use total amount of all orders as condition
orderAmount
string
Total for all orders
useMemberships
boolean
Use memberships as condition
memberships
[] array
Memberships
useProducts
boolean
Use specified products as condition
products
[] array
Products
profiles
[] array
Profiles
enabled
boolean
Enabled