Add order

POST

https://api.mailchimp.com/3.0/ecommerce/stores/:store_id/orders

POST

/3.0/ecommerce/stores/:store_id/orders

curl -X POST https://api.mailchimp.com/3.0/ecommerce/stores/store_id/orders \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "currency_code": "string",
  "customer": {
    "id": "string"
  },
  "id": "string",
  "lines": [
    {
      "id": "string",
      "price": 1.1,
      "product_id": "string",
      "product_variant_id": "string",
      "quantity": 1
    }
  ],
  "order_total": 1.1
}'

200Successful

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "billing_address": {
    "address1": "675 Ponce de Leon Ave NE",
    "address2": "Suite 5000",
    "city": "Atlanta",
    "company": "string",
    "country": "United States",
    "country_code": "US",
    "latitude": 45.427408,
    "longitude": -75.68903,
    "name": "Freddie Chimpenheimer",
    "phone": "8675309",
    "postal_code": "30308",
    "province": "Georgia",
    "province_code": "GA"
  },
  "campaign_id": "839488a60b",
  "cart_id": "cart-123",
  "cancelled_at_foreign": "2015-07-15T19:28:00+00:00",
  "currency_code": "string",
  "customer": {
    "_links": [
      {
        "href": "string",
        "method": "GET",
        "rel": "string",
        "schema": "string",
        "targetSchema": "string"
      }
    ],
    "address": {
      "address1": "675 Ponce de Leon Ave NE",
      "address2": "Suite 5000",
      "city": "Atlanta",
      "country": "United States",
      "country_code": "US",
      "postal_code": "30308",
      "province": "Georgia",
      "province_code": "GA"
    },
    "company": "string",
    "created_at": "2015-07-15T19:28:00+00:00",
    "email_address": "string",
    "first_name": "string",
    "id": "string",
    "last_name": "string",
    "opt_in_status": true,
    "orders_count": 4,
    "sms_phone_number": "string",
    "total_spent": 1.1,
    "updated_at": "2015-07-15T19:28:00+00:00"
  },
  "discount_total": 1.1,
  "financial_status": "string",
  "fulfillment_status": "string",
  "id": "string",
  "landing_site": "http://www.example.com?source=abc",
  "lines": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "discount": 1.1,
      "id": "string",
      "image_url": "string",
      "price": 1.1,
      "product_id": "string",
      "product_title": "string",
      "product_variant_id": "string",
      "product_variant_title": "string",
      "quantity": 1
    }
  ],
  "order_total": 1.1,
  "order_url": "string",
  "outreach": {
    "id": "839488a60b",
    "name": "Freddie's Jokes",
    "published_time": "2017-06-06T13:56:12+00:00",
    "type": "regular"
  },
  "processed_at_foreign": "2015-07-15T19:28:00+00:00",
  "promos": [
    {
      "amount_discounted": 1.1,
      "code": "string",
      "type": "fixed"
    }
  ],
  "shipping_address": {
    "address1": "675 Ponce de Leon Ave NE",
    "address2": "Suite 5000",
    "city": "Atlanta",
    "company": "string",
    "country": "United States",
    "country_code": "US",
    "latitude": 45.427408,
    "longitude": -75.68903,
    "name": "Freddie Chimpenheimer",
    "phone": "8675309",
    "postal_code": "30308",
    "province": "Georgia",
    "province_code": "GA"
  },
  "shipping_total": 1.1,
  "store_id": "string",
  "tax_total": 1.1,
  "tracking_carrier": "string",
  "tracking_code": "prec",
  "tracking_number": "string",
  "tracking_url": "string",
  "updated_at_foreign": "2015-07-15T19:28:00+00:00"
}

Add a new order to a store.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

store_idstringRequired

The store id.

Request

Information about a specific order.

currency_codestringRequired

The three-letter ISO 4217 code for the currency that the store accepts.

customerobjectRequired

Information about a specific customer. For existing customers include only the id parameter in the customer object body.

idstringRequiredformat: "\S">=1 character

A unique identifier for the order.

lineslist of objectsRequired

An array of the order's line items.

order_totaldouble or stringRequired

billing_addressobjectOptional

The billing address for the order.

campaign_idstringOptional

A string that uniquely identifies the campaign for an order.

cart_idstring or integerOptional

A cart id that the order was placed for.

cancelled_at_foreignstringOptional

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.

discount_totaldouble or stringOptional

financial_statusstringOptional

The order status. Use this parameter to trigger Order Notifications.

fulfillment_statusstringOptional

The fulfillment status for the order. Use this parameter to trigger Order Notifications.

landing_sitestringOptional

The URL for the page where the buyer landed when entering the shop.

order_urlstringOptional

The URL for the order.

outreachobjectOptional

The outreach associated with this order. For example, an email campaign or Facebook ad.

processed_at_foreignstringOptional

The date and time the order was processed in ISO 8601 format.

promoslist of objectsOptional

The promo codes applied on the order

shipping_addressobjectOptional

The shipping address for the order.

shipping_totaldouble or stringOptional

tax_totaldouble or stringOptional

tracking_carrierstringOptional

The tracking carrier associated with the order.

tracking_codeenumOptional

The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs.

Allowed values:

tracking_numberstringOptional

The tracking number associated with the order.

tracking_urlstringOptional

The tracking URL associated with the order.

updated_at_foreignstringOptional

The date and time the order was updated in ISO 8601 format.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

billing_addressobjectOptional

The billing address for the order.

campaign_idstringOptional

A string that uniquely identifies the campaign associated with an order.

cart_idstringOptional

A cart id that the order was placed for.

cancelled_at_foreigndatetimeOptional

The date and time the order was cancelled in ISO 8601 format.

currency_codestringOptional