Process Checkout

Error

A valid request URL is required to generate request examples

{
  "order_id": 789,
  "status": "processing",
  "order_key": "wc_order_abc123xyz",
  "order_number": "789",
  "payment_result": {
    "payment_status": "success",
    "redirect_url": "https://example.com/checkout/order-received/789/?key=wc_order_abc123xyz",
    "message": "Payment successful"
  },
  "customer_id": 123,
  "billing_address": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "shipping_address": {
    "first_name": "John",
    "last_name": "Doe",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "cart_key": null
}

POST

checkout

Process checkout

curl --request POST \
  --url {protocol}://{host}/wp-json/cocart/preview/checkout \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_address": {
    "first_name": "<string>",
    "last_name": "<string>",
    "company": "<string>",
    "address_1": "<string>",
    "address_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "email": "[email protected]"
  },
  "shipping_address": {
    "first_name": "<string>",
    "last_name": "<string>",
    "company": "<string>",
    "address_1": "<string>",
    "address_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "country": "<string>"
  },
  "use_different_billing": true,
  "payment_method": "<string>",
  "payment_data": [
    {
      "key": "wc-stripe-payment-token",
      "value": "<string>"
    }
  ],
  "shipping_method": "<string>",
  "currency": "USD",
  "create_account": false,
  "customer_password": "<string>",
  "customer_note": "<string>"
}
'

{
  "order_id": 789,
  "status": "processing",
  "order_key": "wc_order_abc123xyz",
  "order_number": "789",
  "payment_result": {
    "payment_status": "success",
    "redirect_url": "https://example.com/checkout/order-received/789/?key=wc_order_abc123xyz",
    "message": "Payment successful"
  },
  "customer_id": 123,
  "billing_address": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "shipping_address": {
    "first_name": "John",
    "last_name": "Doe",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "cart_key": null
}

This endpoint is currently shown as a preview of what’s currently in development and is subject to change.

Overview

This endpoint completes the checkout process by creating an order and processing payment. Use this after collecting all necessary checkout information and customer details.

Body

application/json

Checkout completion data

billing_address

object

required

Show child attributes

billing_address.first_name

string

First name

billing_address.last_name

string

Last name

billing_address.company

string

Company name

billing_address.address_1

string

Address line 1

billing_address.address_2

string

Address line 2

billing_address.city

string

City name

billing_address.state

string

State/County

billing_address.postcode

string

Postal code

billing_address.country

string

Country code

billing_address.phone

string

Phone number

billing_address.email

string<email>

Email address

shipping_address

object

Show child attributes

shipping_address.first_name

string

First name

shipping_address.last_name

string

Last name

shipping_address.company

string

Company name

shipping_address.address_1

string

Address line 1

shipping_address.address_2

string

Address line 2

shipping_address.city

string

City name

shipping_address.state

string

State/County

shipping_address.postcode

string

Postal code

shipping_address.country

string

Country code

use_different_billing

boolean

default:true

Whether to use a different billing address from shipping

payment_method

string

Payment method ID

payment_data

object[]

Payment data to pass through to the payment gateway

Show child attributes

payment_data.key

string

required

Payment data key

Example:

"wc-stripe-payment-token"

payment_data.value

required

Payment data value

shipping_method

string

Shipping method ID

currency

string

Currency code for the order (e.g., USD, EUR, GBP). Enables multi-currency support with compatible plugins. If not provided, store default will be used.

Example:

"USD"

create_account

boolean

default:false

Create customer account during checkout (for guest checkout)

customer_password

string

Password for new customer account (required if create_account is true)

customer_note

string

Customer note for the order

Response

Checkout processed successfully

order_id

integer

Created order ID

status

string

Order status

order_key

string

Order key

order_number

string

Order number

payment_result

object

Show child attributes

payment_result.payment_status

enum<string>

Available options:

success,

failed,

no_payment_required

payment_result.redirect_url

string<uri>

Redirect URL after payment

payment_result.message

string

Payment message

customer_id

integer

Customer ID

billing_address

object

Show child attributes

billing_address.first_name

string

First name

billing_address.last_name

string

Last name

billing_address.company

string

Company name

billing_address.address_1

string

Address line 1

billing_address.address_2

string

Address line 2

billing_address.city

string

City name

billing_address.state

string

State/County

billing_address.postcode

string

Postal code

billing_address.country

string

Country code

billing_address.phone

string

Phone number

billing_address.email

string<email>

Email address

shipping_address

object

Show child attributes

shipping_address.first_name

string

First name

shipping_address.last_name

string

Last name

shipping_address.company

string

Company name

shipping_address.address_1

string

Address line 1

shipping_address.address_2

string

Address line 2

shipping_address.city

string

City name

shipping_address.state

string

State/County

shipping_address.postcode

string

Postal code

shipping_address.country

string

Country code

cart_key

string | null

Cart key (null after successful checkout)

Checkout

Update Checkout

⌘I

Overview

JWT Authentication

API v1 (Deprecated in future)

API v2

Plugins

Resources

Overview

Body

Response

Overview

JWT Authentication

API v1 (Deprecated in future)

API v2

Plugins

Resources

​Overview

Body

Response

Overview