Create a Draft Order

Prod Env

POST

/admin/draft-orders

Create a Draft Order. A draft order is not transformed into an order until payment is captured.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST '{{baseURL}}/admin/draft-orders' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@example.com",
    "region_id": "string",
    "customer_id": "string",
    "no_notification_order": true,
    "status": "open",
    "metadata": {},
    "discounts": [
        {
            "code": "string"
        }
    ],
    "shipping_methods": [
        {
            "option_id": "string",
            "data": {},
            "price": 0
        }
    ],
    "items": [
        {
            "variant_id": "string",
            "unit_price": 0,
            "title": "string",
            "quantity": 0,
            "metadata": {}
        }
    ],
    "billing_address": {
        "first_name": "Arno",
        "last_name": "Willms",
        "phone": 16128234334802,
        "company": "string",
        "address_1": "14433 Kemmer Court",
        "address_2": "Suite 369",
        "city": "South Geoffreyview",
        "province": "Kentucky",
        "postal_code": 72093,
        "country_code": "st",
        "metadata": {
            "car": "white"
        }
    },
    "shipping_address": {
        "first_name": "Arno",
        "last_name": "Willms",
        "phone": 16128234334802,
        "company": "string",
        "address_1": "14433 Kemmer Court",
        "address_2": "Suite 369",
        "city": "South Geoffreyview",
        "province": "Kentucky",
        "postal_code": 72093,
        "country_code": "st",
        "metadata": {
            "car": "white"
        }
    }
}'

Response Example

200 - Example 1

{
    "draft_order": {
        "id": "dorder_01G8TJFKBG38YYFQ035MSVG03C",
        "display_id": 2,
        "cart_id": "cart_01G8ZH853Y6TFXWPG5EYE81X63",
        "cart": {},
        "order_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK",
        "order": {},
        "canceled_at": "2019-08-24T14:15:22Z",
        "completed_at": "2019-08-24T14:15:22Z",
        "no_notification_order": false,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "status": "open",
        "idempotency_key": "string",
        "metadata": {
            "car": "white"
        }
    }
}

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2025-07-23 05:41:28

Get a Draft Order

List Draft Orders