Checkout with Account Management Authentication Token

POST 
/v2/carts/:cartID/checkout

When a Cart is ready for checkout, you can convert the cart to an order. The cart remains and can be modified and checked out again if required.

After a successful checkout, a response that contains the order is returned.

caution

• By default, carts are automatically deleted 7 days after the last update. You can change this setting by updating cart settings.
• Your inventory is modified during checkout and payment of an order. For more information about the changes in the inventory, see the Inventory section.

The shopper authenticates with the Implicit Token and the EP-Account-Management-Authentication-Token.

Request

Path Parameters

cartID stringrequired

The ID of the cart that you want to checkout.

Header Parameters

EP-Account-Management-Authentication-Token string

An account management authentication token that identifies the authenticated account member.

application/json

Body

data object

billing_address object

company_name string

Company name of the billing recipient.

country stringrequired

Specifies the country of the billing address.

county string

Specifies the county of the billing address.

first_name stringrequired

First name of the billing recipient.

last_name stringrequired

Last name of the billing recipient.

line_1 stringrequired

First line of the billing address.

line_2 string

Second line of the billing address.

postcode stringrequired

Postcode of the billing address.

region stringrequired

Specifies state, province, or region of the billing address.

contact object

email string

The email address of the contact.

name string

The name of the contact.

shipping_address object

company_name string

Company of the shipping recipient.

country stringrequired

Specifies the country of the shipping address.

county string

Specifies the county of the shipping address.

first_name stringrequired

First name of the shipping recipient.

last_name stringrequired

Last name of the shipping recipient.

line_1 stringrequired

First line of the shipping address.

line_2 string

Second line of the shipping address.

postcode stringrequired

Post code of the shipping address.

region stringrequired

Specifies the state, province, or region of the shipping address.

Responses

200

OK

application/json

Schema

Schema

data object

type string

Specifies the type of object being returned. You must use order.

id uuid

Specifies the unique identifier of the order.

status string

Specifies the status of the order, such as incomplete, complete, processing, or cancelled.

payment string

Specifies the status of the payment, such as unpaid, authorized, paid, or refunded.

shipping string

Specifies the status of the shipment, such as fulfilled or unfulfilled.

anonymized boolean

Specifies if the order is anonymized.

meta object

timestamps object

created_at string

The date this was created.

updated_at

The date this was last updated.

with_tax object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

without_tax object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

tax object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

discount object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

paid object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

authorized object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

without_discount object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

billing_address object

company_name string

Company name of the billing recipient.

country stringrequired

Specifies the country of the billing address.

county string

Specifies the county of the billing address.

first_name stringrequired

First name of the billing recipient.

last_name stringrequired

Last name of the billing recipient.

line_1 stringrequired

First line of the billing address.

line_2 string

Second line of the billing address.

postcode stringrequired

Postcode of the billing address.

region stringrequired

Specifies state, province, or region of the billing address.

contact object

email string

The email address of the contact.

name string

The name of the contact.

shipping_address object

company_name string

Company of the shipping recipient.

country stringrequired

Specifies the country of the shipping address.

county string

Specifies the county of the shipping address.

first_name stringrequired

First name of the shipping recipient.

last_name stringrequired

Last name of the shipping recipient.

line_1 stringrequired

First line of the shipping address.

line_2 string

Second line of the shipping address.

postcode stringrequired

Post code of the shipping address.

region stringrequired

Specifies the state, province, or region of the shipping address.

Example (from schema)

{
  "data": {
    "type": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "string",
    "payment": "string",
    "shipping": "string",
    "anonymized": true,
    "meta": {
      "timestamps": {
        "created_at": "string"
      },
      "with_tax": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "without_tax": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "tax": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "discount": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "paid": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "authorized": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "without_discount": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      }
    },
    "billing_address": {
      "company_name": "string",
      "country": "string",
      "county": "string",
      "first_name": "string",
      "last_name": "string",
      "line_1": "string",
      "line_2": "string",
      "postcode": "string",
      "region": "string"
    },
    "contact": {
      "email": "string",
      "name": "string"
    },
    "shipping_address": {
      "company_name": "string",
      "country": "string",
      "county": "string",
      "first_name": "string",
      "last_name": "string",
      "line_1": "string",
      "line_2": "string",
      "postcode": "string",
      "region": "string"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Loading...