Order Received

Error

A valid request URL is required to generate request examples

{
  "order_id": 789,
  "order_number": "789",
  "order_key": "wc_order_abc123xyz",
  "status": "processing",
  "status_name": "Processing",
  "date_created": "December 15, 2024, 2:20 pm",
  "date_paid": "December 15, 2024, 2:21 pm",
  "currency": "USD",
  "total": "44.98",
  "subtotal": "39.98",
  "tax_total": "0.00",
  "shipping_total": "5.00",
  "discount_total": "0.00",
  "payment_method": "stripe",
  "payment_method_title": "Credit Card (Stripe)",
  "customer_id": 123,
  "customer_note": "Please leave at the door",
  "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": ""
  },
  "items": [
    {
      "item_id": 1,
      "product_id": 456,
      "variation_id": 0,
      "product_name": "Premium T-Shirt",
      "product_image": "https://example.com/wp-content/uploads/product.jpg",
      "quantity": 2,
      "subtotal": "39.98",
      "total": "39.98",
      "meta_data": []
    }
  ],
  "totals": [
    {
      "key": "subtotal",
      "label": "Subtotal",
      "value": "$39.98"
    },
    {
      "key": "shipping",
      "label": "Shipping",
      "value": "$5.00"
    },
    {
      "key": "total",
      "label": "Total",
      "value": "$44.98"
    }
  ],
  "needs_payment": false,
  "needs_shipping": true,
  "has_downloads": false,
  "download_url": null
}

GET

order-received

{order_id}

Get order received details

curl --request GET \
  --url {protocol}://{host}/wp-json/cocart/preview/order-received/{order_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "order_id": 789,
  "order_number": "789",
  "order_key": "wc_order_abc123xyz",
  "status": "processing",
  "status_name": "Processing",
  "date_created": "December 15, 2024, 2:20 pm",
  "date_paid": "December 15, 2024, 2:21 pm",
  "currency": "USD",
  "total": "44.98",
  "subtotal": "39.98",
  "tax_total": "0.00",
  "shipping_total": "5.00",
  "discount_total": "0.00",
  "payment_method": "stripe",
  "payment_method_title": "Credit Card (Stripe)",
  "customer_id": 123,
  "customer_note": "Please leave at the door",
  "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": ""
  },
  "items": [
    {
      "item_id": 1,
      "product_id": 456,
      "variation_id": 0,
      "product_name": "Premium T-Shirt",
      "product_image": "https://example.com/wp-content/uploads/product.jpg",
      "quantity": 2,
      "subtotal": "39.98",
      "total": "39.98",
      "meta_data": []
    }
  ],
  "totals": [
    {
      "key": "subtotal",
      "label": "Subtotal",
      "value": "$39.98"
    },
    {
      "key": "shipping",
      "label": "Shipping",
      "value": "$5.00"
    },
    {
      "key": "total",
      "label": "Total",
      "value": "$44.98"
    }
  ],
  "needs_payment": false,
  "needs_shipping": true,
  "has_downloads": false,
  "download_url": null
}

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

Authorizations

Authorization

string

header

required

WordPress username and password

Path Parameters

order_id

integer

required

Unique identifier for the order

Query Parameters

order_key

string

required

Order key for verification

Response

Order received details retrieved successfully

order_id

integer

Order ID

order_number

string

Order number

order_key

string

Order key

status

string

Order status

status_name

string

Human-readable order status

date_created

string

Order creation date

date_paid

string | null

Order payment date

currency

string

Order currency

total

string

Order total

subtotal

string

Order subtotal

tax_total

string

Tax total

shipping_total

string

Shipping total

discount_total

string

Discount total

payment_method

string

Payment method ID

payment_method_title

string

Payment method title

customer_id

integer

Customer ID

customer_note

string

Customer note

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

items

object[]

Show child attributes

items.item_id

integer

Item ID

items.product_id

integer

Product ID

items.variation_id

Variation ID (integer for existing variations, string for deleted variations)

items.product_image

string<uri>

Product image URL

items.product_name

string

Product name

items.product_title

string

Product title

items.product_type

string

Product type

items.sku

string

Product SKU

items.quantity

string

Item quantity

items.subtotal

string

Item subtotal

items.purchase_note

string

Purchase note

items.refunded_qty

string

Refunded quantity

items.meta

object

Item metadata

items.link

string<uri>

Link to product

totals

object[]

Show child attributes

totals.key

string

totals.label

string

totals.value

string

needs_payment

boolean

Whether order requires payment

needs_shipping

boolean

Whether order needs shipping

has_downloads

boolean

Whether order has downloadable items

download_url

string<uri> | null

URL to download items

available_payment_methods

object[]

Show child attributes

available_payment_methods.id

string

available_payment_methods.title

string

available_payment_methods.description

string

available_payment_methods.has_fields

boolean

Get Full Address Details

Pay for Order

⌘I

Overview

JWT Authentication

API v1 (Deprecated in future)

API v2

Plugins

Resources

Authorizations

Path Parameters

Query Parameters

Response