EcommerceGetPromoCodeResponse
{
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
}
EcommerceGetPromoCodedefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStoreCarts200Response
{
"type": "object",
"title": "Carts",
"properties": {
"carts": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
},
"title": "E-commerce Store Carts",
"description": "An array of objects, each representing a cart."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a store's carts."
}
EcommerceGetStoreCartsResponse
{
"type": "object",
"title": "Carts",
"properties": {
"carts": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
},
"title": "E-commerce Store Carts",
"description": "An array of objects, each representing a cart."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a store's carts."
}
EcommerceGetStoreCartsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStoreCustomers200Response
{
"type": "object",
"title": "Customers",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"customers": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"title": "Customers",
"description": "An array of objects, each representing a customer of a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's customers."
}
EcommerceGetStoreCustomersResponse
{
"type": "object",
"title": "Customers",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"customers": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"title": "Customers",
"description": "An array of objects, each representing a customer of a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's customers."
}
EcommerceGetStoreCustomersdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStoreInfo200Response
{
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceGetStoreInfoResponse
{
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceGetStoreInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStoreOrderInfo200Response
{
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceGetStoreOrderInfoResponse
{
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceGetStoreOrderInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStoreOrderLines200Response
{
"type": "object",
"title": "Order Lines",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Ecommerce Order Lines",
"description": "An array of objects, each representing an order's line item."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"order_id": {
"type": "string",
"title": "Order ID",
"description": "The order id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of an order's line items."
}
EcommerceGetStoreOrderLinesResponse
{
"type": "object",
"title": "Order Lines",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Ecommerce Order Lines",
"description": "An array of objects, each representing an order's line item."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"order_id": {
"type": "string",
"title": "Order ID",
"description": "The order id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of an order's line items."
}
EcommerceGetStoreOrderLinesdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStoreProductInfo200Response
{
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
}
EcommerceGetStoreProductInfoResponse
{
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
}
EcommerceGetStoreProductInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStoreProducts200Response
{
"type": "object",
"title": "Products",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"products": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
},
"title": "Products",
"description": "An array of objects, each representing a store product."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a store's products."
}
EcommerceGetStoreProductsResponse
{
"type": "object",
"title": "Products",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"products": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
},
"title": "Products",
"description": "An array of objects, each representing a store product."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a store's products."
}
EcommerceGetStoreProductsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStorePromoCodes200Response
{
"type": "object",
"title": "Promo Codes",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"promo_codes": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
},
"title": "Promo Codes",
"description": "An array of objects, each representing promo codes defined for a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's promo codes."
}
EcommerceGetStorePromoCodesResponse
{
"type": "object",
"title": "Promo Codes",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"promo_codes": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
},
"title": "Promo Codes",
"description": "An array of objects, each representing promo codes defined for a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's promo codes."
}
EcommerceGetStorePromoCodesdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStorePromoRule200Response
{
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
}
EcommerceGetStorePromoRuleResponse
{
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
}
EcommerceGetStorePromoRuledefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceGetStorePromoRules200Response
{
"type": "object",
"title": "Promo Rules",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"promo_rules": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
},
"title": "Promo Rules",
"description": "An array of objects, each representing promo rules defined for a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's promo rules."
}
EcommerceGetStorePromoRulesResponse
{
"type": "object",
"title": "Promo Rules",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"promo_rules": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
},
"title": "Promo Rules",
"description": "An array of objects, each representing promo rules defined for a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's promo rules."
}
EcommerceGetStorePromoRulesdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceListAccountOrders200Response
{
"type": "object",
"title": "Orders",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"orders": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
},
"title": "Orders",
"description": "An array of objects, each representing an order resource."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of orders in an account."
}
EcommerceListAccountOrdersResponse
{
"type": "object",
"title": "Orders",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"orders": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
},
"title": "Orders",
"description": "An array of objects, each representing an order resource."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of orders in an account."
}
EcommerceListAccountOrdersdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceListCartLines200Response
{
"type": "object",
"title": "Cart Lines",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Ecommerce Cart Lines",
"description": "An array of objects, each representing a cart's line item."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"cart_id": {
"type": "string",
"title": "Cart ID",
"description": "The cart id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a cart's line items."
}
EcommerceListCartLinesResponse
{
"type": "object",
"title": "Cart Lines",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Ecommerce Cart Lines",
"description": "An array of objects, each representing a cart's line item."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"cart_id": {
"type": "string",
"title": "Cart ID",
"description": "The cart id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a cart's line items."
}
EcommerceListCartLinesdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceListProductVariants200Response
{
"type": "object",
"title": "Ecommerce Product Variants",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Ecommerce Product Variants",
"description": "An array of objects, each representing a product's variants."
},
"product_id": {
"type": "string",
"title": "Product ID",
"description": "The product id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a product's variants."
}
EcommerceListProductVariantsResponse
{
"type": "object",
"title": "Ecommerce Product Variants",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Ecommerce Product Variants",
"description": "An array of objects, each representing a product's variants."
},
"product_id": {
"type": "string",
"title": "Product ID",
"description": "The product id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a product's variants."
}
EcommerceListProductVariantsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceListStoreOrders200Response
{
"type": "object",
"title": "Orders",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"orders": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
},
"title": "Orders",
"description": "An array of objects, each representing an order in a store."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The unique identifier for the store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of orders in a store."
}
EcommerceListStoreOrdersResponse
{
"type": "object",
"title": "Orders",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"orders": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
},
"title": "Orders",
"description": "An array of objects, each representing an order in a store."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The unique identifier for the store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of orders in a store."
}
EcommerceListStoreOrdersdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceListStores200Response
{
"type": "object",
"title": "E-commerce Stores",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"stores": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
},
"title": "Stores",
"description": "An array of objects, each representing a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of stores in the account."
}
EcommerceListStoresResponse
{
"type": "object",
"title": "E-commerce Stores",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"stores": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
},
"title": "Stores",
"description": "An array of objects, each representing a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of stores in the account."
}
EcommerceListStoresdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceRemoveCartResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceRemoveCartdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
EcommerceRemoveCustomerResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}