ecommerce

Add cart

Add a new cart to a store.

post/3.0/ecommerce/stores/{store_id}/carts

Request

Path parameters

store_idstring required

The store id.

Request body

campaign_idstring

A string that uniquely identifies the campaign for a cart.

checkout_urlstring

The URL for the cart. This parameter is required for Abandoned Cart automations.

currency_codestring required

The three-letter ISO 4217 code for the currency that the cart uses.

Example request

{
  "campaign_id": "839488a60b",
  "customer": {
    "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"
    }
  }
}

Response

campaign_idstring

A string that uniquely identifies the campaign associated with a cart.

checkout_urlstring

The URL for the cart. This parameter is required for Abandoned Cart automations.

created_atstring date-time

The date and time the cart was created in ISO 8601 format.

currency_codestring

The three-letter ISO 4217 code for the currency that the cart uses.

idstring

A unique identifier for the cart.

order_totalnumber

The order total for the cart.

tax_totalnumber

The total tax for the cart.

updated_atstring date-time

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

Example response

{
  "campaign_id": "839488a60b",
  "created_at": "2015-07-15T19:28:00+00:00",
  "customer": {
    "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"
    },
    "created_at": "2015-07-15T19:28:00+00:00",
    "orders_count": 4,
    "updated_at": "2015-07-15T19:28:00+00:00"
  },
  "updated_at": "2015-07-15T19:28:00+00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.