ConversationsGetMessageByIddefaultResponse
{
"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'."
}
ConversationsListMessagesFromConversation200Response
{
"type": "object",
"title": "Collection of Conversation Messages",
"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."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"description": "A string that identifies this conversation."
},
"conversation_messages": {
"type": "array",
"items": {
"type": "object",
"title": "Conversation Message",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this message"
},
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read"
},
"_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."
},
"list_id": {
"type": "integer",
"title": "List ID",
"readOnly": true,
"description": "The list's web ID"
},
"message": {
"type": "string",
"title": "Message",
"description": "The plain-text content of the message"
},
"subject": {
"type": "string",
"title": "Subject",
"description": "The subject of this message"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "A label representing the email of the sender of this message"
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message"
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"readOnly": true,
"description": "A string that identifies this message's conversation"
}
},
"description": "An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
},
"title": "Conversation Messages",
"description": "An array of objects, each representing a conversation messages resources."
}
},
"description": "Messages from a specific conversation."
}
ConversationsListMessagesFromConversationResponse
{
"type": "object",
"title": "Collection of Conversation Messages",
"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."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"description": "A string that identifies this conversation."
},
"conversation_messages": {
"type": "array",
"items": {
"type": "object",
"title": "Conversation Message",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this message"
},
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read"
},
"_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."
},
"list_id": {
"type": "integer",
"title": "List ID",
"readOnly": true,
"description": "The list's web ID"
},
"message": {
"type": "string",
"title": "Message",
"description": "The plain-text content of the message"
},
"subject": {
"type": "string",
"title": "Subject",
"description": "The subject of this message"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "A label representing the email of the sender of this message"
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message"
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"readOnly": true,
"description": "A string that identifies this message's conversation"
}
},
"description": "An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
},
"title": "Conversation Messages",
"description": "An array of objects, each representing a conversation messages resources."
}
},
"description": "Messages from a specific conversation."
}
ConversationsListMessagesFromConversationdefaultResponse
{
"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'."
}
CustomerJourneysTriggerStepAction204Response
{
"description": "Empty Response"
}
CustomerJourneysTriggerStepActionRequest
{
"type": "object",
"title": "Subscriber in Customer Journey's audience",
"required": [
"email_address"
],
"properties": {
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "Information about subscribers in a Customer Journey's audience."
}
CustomerJourneysTriggerStepActionResponse
{
"type": "object",
"example": {},
"properties": {}
}
CustomerJourneysTriggerStepActiondefaultResponse
{
"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'."
}
EcommerceAddCartLineItem200Response
{
"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."
}
EcommerceAddCartLineItemRequest
{
"type": "object",
"title": "E-commerce Cart Line Item",
"required": [
"id",
"product_id",
"product_variant_id",
"quantity",
"price"
],
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"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_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."
}
},
"description": "Information about a specific cart line item."
}
EcommerceAddCartLineItemResponse
{
"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."
}
EcommerceAddCartLineItemdefaultResponse
{
"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'."
}
EcommerceAddCartToStore200Response
{
"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."
}
EcommerceAddCartToStoreRequest
{
"type": "object",
"title": "E-commerce Cart",
"required": [
"id",
"currency_code",
"customer",
"order_total",
"lines"
],
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"required": [
"id",
"product_id",
"product_variant_id",
"quantity",
"price"
],
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"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_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."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"maxLength": 50,
"description": "A unique identifier for the customer. Limited to 50 characters."
},
"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."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"email_address": {
"type": "string",
"title": "Email Address",
"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. For existing customers include only the `id` parameter in the `customer` object body."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign for 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."
}
EcommerceAddCartToStoreResponse
{
"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."
}
EcommerceAddCartToStoredefaultResponse
{
"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'."
}
EcommerceAddCustomerToStore200Response
{
"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."
}
EcommerceAddCustomerToStoreRequest
{
"type": "object",
"title": "E-commerce Customer",
"required": [
"id",
"email_address",
"opt_in_status"
],
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"maxLength": 50,
"description": "A unique identifier for the customer. Limited to 50 characters."
},
"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."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"email_address": {
"type": "string",
"title": "Email Address",
"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."
}
EcommerceAddCustomerToStoreResponse
{
"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."
}
EcommerceAddCustomerToStoredefaultResponse
{
"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'."
}
EcommerceAddOrUpdateCustomer200Response
{
"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."
}
EcommerceAddOrUpdateCustomerRequest
{
"type": "object",
"title": "E-commerce Customer",
"required": [
"id",
"email_address",
"opt_in_status"
],
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"maxLength": 50,
"description": "A unique identifier for the customer. Limited to 50 characters."
},
"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."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"email_address": {
"type": "string",
"title": "Email Address",
"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. Orders for existing customers should include only the `id` parameter in the `customer` object body."
}
EcommerceAddOrUpdateCustomerResponse
{
"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."
}
EcommerceAddOrUpdateCustomerdefaultResponse
{
"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'."
}
EcommerceAddOrUpdateProductVariant200Response
{
"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."
}
EcommerceAddOrUpdateProductVariantResponse
{
"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."
}
EcommerceAddOrUpdateProductVariantdefaultResponse
{
"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'."
}
EcommerceAddOrderLineItem200Response
{
"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."
}
EcommerceAddOrderLineItemRequest
{
"type": "object",
"title": "E-commerce Order Line Item",
"required": [
"id",
"product_id",
"product_variant_id",
"quantity",
"price"
],
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"description": "A unique identifier for the order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of an order line item."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to this line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of an order line item."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with the 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 the order line item."
}
},
"description": "Information about a specific order line."
}
EcommerceAddOrderLineItemResponse
{
"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."
}
EcommerceAddOrderLineItemdefaultResponse
{
"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'."
}
EcommerceAddOrderToStore200Response
{
"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."
}
EcommerceAddOrderToStoreRequest
{
"type": "object",
"title": "E-commerce Order",
"required": [
"id",
"customer",
"currency_code",
"order_total",
"lines"
],
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"required": [
"id",
"product_id",
"product_variant_id",
"quantity",
"price"
],
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"description": "A unique identifier for the order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of an order line item."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to this line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of an order line item."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with the 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 the order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"type",
"amount_discounted"
],
"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",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"maxLength": 50,
"description": "A unique identifier for the customer. Limited to 50 characters."
},
"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."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"email_address": {
"type": "string",
"title": "Email Address",
"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. For existing customers include only the `id` parameter in the `customer` object body."
},
"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."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total for the order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign for an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The total for the 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 the 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 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 the shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the 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 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 in the shipping address."
}
},
"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. Note: passing a value for this parameter will cancel the order being created."
},
"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."
}
EcommerceAddOrderToStoreResponse
{
"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."
}
EcommerceAddOrderToStoredefaultResponse
{
"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'."
}
EcommerceAddProductImage200Response
{
"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."
}
EcommerceAddProductImageRequest
{
"type": "object",
"title": "E-commerce Product Image",
"required": [
"id",
"url"
],
"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."
},
"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."
}
EcommerceAddProductImageResponse
{
"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."
}
EcommerceAddProductImagedefaultResponse
{
"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'."
}
EcommerceAddProductToStore200Response
{
"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."
}
EcommerceAddProductToStoreRequest
{
"type": "object",
"title": "E-commerce Product",
"required": [
"id",
"title",
"variants"
],
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"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."
},
"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",
"required": [
"id",
"url"
],
"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."
},
"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",
"required": [
"id",
"title"
],
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"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."
},
"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."
},
"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": "An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product."
},
"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."
},
"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."
}
},
"description": "Information about a specific product."
}
EcommerceAddProductToStoreResponse
{
"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."
}
EcommerceAddProductToStoredefaultResponse
{
"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'."
}
EcommerceAddProductVariant200Response
{
"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."
}
EcommerceAddProductVariantRequest
{
"type": "object",
"title": "E-commerce Product Variant",
"required": [
"id",
"title"
],
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"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."
},
"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."
},
"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."
}
EcommerceAddProductVariantResponse
{
"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."
}
EcommerceAddProductVariantdefaultResponse
{
"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'."
}
EcommerceAddPromoCode200Response
{
"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"
}
EcommerceAddPromoCodeRequest
{
"type": "object",
"title": "E-commerce Promo Code",
"required": [
"id",
"code",
"redemption_url"
],
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"description": "A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"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."
}
EcommerceAddPromoCodeResponse
{
"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"
}