API

42 July 19, 2023

List Customers

List all Studiocart customers.

HTTP request
GET/wp-json/sc/v1/customers
Request Headers

x-api-key – string | studiocart api key Required

Content-Type – application/json

Request Body
{
    "per_page":10,
    "page":1
}
Response

200

Response Body
[
    {
        "id": 1,
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "janedoe@email.com",
        "date_created": "2023-05-27 14:06:02",
        "lifetime_value": 500,
        "total_orders": 1,
        "last_order_date": "2023-05-27 13:44:00"
    },
    {
        "id": 2,
        "first_name": "John",
        "last_name": "",
        "email": "john@email.com",
        "date_created": "2023-05-16 19:56:12",
        "lifetime_value": 11000,
        "total_orders": 11,
        "last_order_date": "2023-05-06 11:33:16"
    }
]

Retrieve a customer

Retrieve a Studiocart Customer object.

HTTP request
GET/wp-json/sc/v1/customers/{customer_id}
Request Headers

x-api-key – string | studiocart api key Required

Content-Type – application/json

Request Body
{}
Response

200

Response Body
    {
        "id": 1,
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "janedoe@email.com",
        "date_created": "2023-05-27 14:06:02",
        "lifetime_value": 500,
        "total_orders": 1,
        "last_order_date": "2023-05-27 13:44:00"
}

List Orders

List all Studiocart orders.

HTTP request
GET/wp-json/sc/v1/orders
Request Headers

x-api-key – string | studiocart api key Required

Content-Type – application/json

Request Body
{
    "per_page":10,
    "page":1,
    "date_after":"2023-07-18",
    "orderby":"id|date_created|date_modified",
    "order":"asc|desc"
}
Response

200

Response Body
[
    {
        "id": 1109,
        "customer_firstname": "Jane",
        "customer_lastname": "Doe",
        "customer_name": "Jane Doe",
        "customer_email": "janedoe@email.com",
        "product_id": "1107",
        "product_name": "SC Product 1",
        "gateway": "stripe",
        "shipping_amount": 0,
        "date": "2023-05-27",
        "date_time": "2023-05-27 08:14:00",
        "payment_plan": "Subscription Payment",
        "payment_plan_id": "price_1N4iASSEsjR3TKDuTSloXYv5",
        "order_amount": 500,
        "tax_amount": 0,
        "pre_tax_amount": 0,
        "tax_rate": 0,
        "tax_type": "tax",
        "currency": "INR",
        "transaction_id": "ch_3NCNPYSEsjR3TKDu0BcJrS1F",
        "status": "paid",
        "items": [
            {
                "product_name": "SC Product 1 x 1",
                "quantity": 1,
                "subtotal": 500,
                "total_amount": 500,
                "tax_amount": 0,
                "unit_price": 500,
                "sub_summary": "$5.00 / month"
            }
        ],
        "invoice_total": 0,
        "invoice_subtotal": 0,
        "website_url": "http://studiocart.local",
        "order_url": "/products/sc-product-1/",
        "link": "http://studiocart.local/wp-json/sc/v1/orders/1109"
    }
]

Retrieve a Order

Retrieve a Studiocart order.

HTTP request
GET/wp-json/sc/v1/orders/{order_id}
Request Headers

x-api-key – string | studiocart api key Required

Content-Type – application/json

Request Body
{}
Response

200

Response Body
{
        "id": 1109,
        "customer_firstname": "Jane",
        "customer_lastname": "Doe",
        "customer_name": "Jane Doe",
        "customer_email": "janedoe@email.com",
        "product_id": "1107",
        "product_name": "SC Product 1",
        "gateway": "stripe",
        "shipping_amount": 0,
        "date": "2023-05-27",
        "date_time": "2023-05-27 08:14:00",
        "payment_plan": "Subscription Payment",
        "payment_plan_id": "price_1N4iASSEsjR3TKDuTSloXYv5",
        "order_amount": 500,
        "tax_amount": 0,
        "pre_tax_amount": 0,
        "tax_rate": 0,
        "tax_type": "tax",
        "currency": "INR",
        "transaction_id": "ch_3NCNPYSEsjR3TKDu0BcJrS1F",
        "status": "paid",
        "items": [
            {
                "product_name": "SC Product 1 x 1",
                "quantity": 1,
                "subtotal": 500,
                "total_amount": 500,
                "tax_amount": 0,
                "unit_price": 500,
                "sub_summary": "$5.00 / month"
            }
        ],
        "invoice_total": 0,
        "invoice_subtotal": 0,
        "website_url": "http://studiocart.local",
        "order_url": "/products/sc-product-1/",
        "link": "http://studiocart.local/wp-json/sc/v1/orders/1109"
    }

List Subscription Orders

List all orders in a subscription.

HTTP request
GET/wp-json/sc/v1/orders/subscription/{subscription_id}
Request Headers

x-api-key – string | studiocart api key Required

Content-Type – application/json

Request Body
{
     "per_page":10, "page":1,
     "date_after":"2023-07-18",
     "orderby":"id|date_created|date_modified",
     "order":"asc|desc"
}
Response

200

Response Body
[
    {
        "id": 1109,
        "customer_firstname": "Jane",
        "customer_lastname": "Doe",
        "customer_name": "Jane Doe",
        "customer_email": "janedoe@email.com",
        "product_id": "1107",
        "product_name": "SC Product 1",
        "gateway": "stripe",
        "shipping_amount": 0,
        "date": "2023-05-27",
        "date_time": "2023-05-27 08:14:00",
        "payment_plan": "Subscription Payment",
        "payment_plan_id": "price_1N4iASSEsjR3TKDuTSloXYv5",
        "order_amount": 500,
        "tax_amount": 0,
        "pre_tax_amount": 0,
        "tax_rate": 0,
        "tax_type": "tax",
        "currency": "INR",
        "transaction_id": "ch_3NCNPYSEsjR3TKDu0BcJrS1F",
        "status": "paid",
        "items": [
            {
                "product_name": "SC Product 1 x 1",
                "quantity": 1,
                "subtotal": 500,
                "total_amount": 500,
                "tax_amount": 0,
                "unit_price": 500,
                "sub_summary": "$5.00 / month"
            }
        ],
        "invoice_total": 0,
        "invoice_subtotal": 0,
        "website_url": "http://studiocart.local",
        "order_url": "/products/sc-product-1/",
        "link": "http://studiocart.local/wp-json/sc/v1/orders/1109"
    }
]

List Subscriptions

List all Studiocart subscriptions.

HTTP request
GET/wp-json/sc/v1/subscriptions
Request Headers

x-api-key – string | studiocart api key Required

Content-Type – application/json

Request Body
{
    "per_page":10,
    "page":1,
    "date_after":"2023-07-18",
    "orderby":"id|date_created|date_modified",
    "order":"asc|desc"
}
Response

200

Response Body
[
    {
        "id": 1108,
        "customer_firstname": "Jane",
        "customer_lastname": "Doe",
        "customer_name": "Jane Doe",
        "customer_email": "janedoe@email.com",
        "product_id": "1107",
        "product_name": "SC Product 1",
        "gateway": "stripe",
        "date": "2023-05-27",
        "date_time": "2023-05-27 08:14:00",
        "payment_plan": "Subscription Payment",
        "payment_plan_id": "price_1N4iASSEsjR3TKDuTSloXYv5",
        "order_amount": 500,
        "tax_amount": 0,
        "tax_rate": 0,
        "tax_type": "tax",
        "currency": "INR",
        "subscription_id": "sub_1NCNPYSEsjR3TKDuWWgFnblY",
        "status": "active",
        "amount": 500,
        "interval": "month",
        "frequency": "1",
        "trial_days": 0,
        "sign_up_fee": 0,
        "next_bill_date": "2023-06-27",
        "next_bill_date_time": "2023-06-27 13:44:00",
        "website_url": "http://studiocart.local",
        "order_url": "/products/sc-product-1/",
        "invoices": [
            {
                "id": 1109,
                "status": "paid",
                "order_amount": 500,
                "date": "2023-05-27",
                "date_time": "2023-05-27 13:44:00",
                "link": "http://studiocart.local/wp-json/sc/v1/orders/1109"
            }
        ],
        "link": "http://studiocart.local/wp-json/sc/v1/subscriptions/1108"
    }
]

Retrieve a Subscription

Retrieve a Studiocart subscription.

HTTP request
GET/wp-json/sc/v1/subscriptions/{subscription_id}
Request Headers

x-api-key – string | studiocart api key Required

Content-Type – application/json

Request Body
{}
Response

200

Response Body
 {
    "id": 1108,
    "customer_firstname": "Jane",
    "customer_lastname": "Doe",
    "customer_name": "Jane Doe",
    "customer_email": "janedoe@email.com",
    "product_id": "1107",
    "product_name": "SC Product 1",
    "gateway": "stripe",
    "date": "2023-05-27",
    "date_time": "2023-05-27 08:14:00",
    "payment_plan": "Subscription Payment",
    "payment_plan_id": "price_1N4iASSEsjR3TKDuTSloXYv5",
    "order_amount": 500,
    "tax_amount": 0,
    "tax_rate": 0,
    "tax_type": "tax",
    "currency": "INR",
    "subscription_id": "sub_1NCNPYSEsjR3TKDuWWgFnblY",
    "status": "active",
    "amount": 500,
    "interval": "month",
    "frequency": "1",
    "trial_days": 0,
    "sign_up_fee": 0,
    "next_bill_date": "2023-06-27",
    "next_bill_date_time": "2023-06-27 13:44:00",
    "website_url": "http://studiocart.local",
    "order_url": "/products/sc-product-1/",
    "invoices": [
        {
            "id": 1109,
            "status": "paid",
            "order_amount": 500,
            "date": "2023-05-27",
            "date_time": "2023-05-27 13:44:00",
            "link": "http://studiocart.local/wp-json/sc/v1/orders/1109"
        }
    ],
    "link": "http://studiocart.local/wp-json/sc/v1/subscriptions/1108"
}

List Products

List all Studiocart products.

HTTP request
GET/wp-json/sc/v1/products
Request Headers

x-api-key – string | studiocart api key Required

Content-Type – application/json

Request Body
{
    "per_page":10,
    "page":1,
    "orderby":"id|date_created|date_modified|product_name",
    "order":"asc|desc"
}
Response

200

Response Body
[
    {
        "id": 1130,
        "name": "SC Product 2",
        "status": "publish",
        "description": "SC Product Description 2",
        "date_created": "2023-05-28 00:58:52",
        "date_updated": "2023-05-28 00:58:52",
        "url": "http://studiocart.local/products/sc-product-2/",
        "image_url": "",
        "is_on_sale": 0,
        "plans": [
            {
                "id": "price_1N4iBnSEsjR3TKDuwYubVqSF",
                "name": "Price Label",
                "price_type": "recurring",
                "price": 400,
                "installments": "-1",
                "interval": "week",
                "frequency": 1,
                "trial_days": null,
                "signup_fee": 0
            }
        ]
    }
]

Retrieve a Product

Retrieve a Studiocart product.

HTTP request
GET/wp-json/sc/v1/products/{product_id}
Request Headers

x-api-key – string | studiocart api key Required

Content-Type – application/json

Request Body
{}
Response

200

Response Body
     {
    "id": 1130,
    "name": "SC Product 2",
    "status": "publish",
    "description": "SC Product Description 2",
    "date_created": "2023-05-28 00:58:52",
    "date_updated": "2023-05-28 00:58:52",
    "url": "http://studiocart.local/products/sc-product-2/",
    "image_url": "",
    "is_on_sale": 0,
    "plans": [
        {
            "id": "price_1N4iBnSEsjR3TKDuwYubVqSF",
            "name": "Price Label",
            "price_type": "recurring",
            "price": 400,
            "installments": "-1",
            "interval": "week",
            "frequency": 1,
            "trial_days": null,
            "signup_fee": 0
        }
    ]
}