Update Order

PUT

/v1/orders/{id}

You can only modify order details while the order status is in draft, new_order or on_hold

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/json

Example

{
    "reference_id": "20231111",
    "order_status": "draft",
    "boost_production": false,
    "line_items": [
        {
            "item_id": "1",
            "sku": "UTNGDT1W00L",
            "name": "Item 1",
            "quantity": 3,
            "print_areas": {
                "front": "https://via.placeholder.com/2400/09f/fff.png",
                "back": "https://via.placeholder.com/2400/09f/fff.png"
            },
            "preview_areas": {
                "front": "https://via.placeholder.com/2400/09f/fff.png",
                "back": "https://via.placeholder.com/2400/09f/fff.png"
            }
        }
    ],
    "address": {
        "name": "Michael Brown",
        "company": "My company",
        "email": "michaelbrown@demo.com",
        "phone": "(330) 829-0294",
        "street1": "3431 Reeves Street",
        "street2": null,
        "city": "Milwaukee",
        "state": "WI",
        "country": "US",
        "zip": "53202"
    },
    "shipping_method": 1
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api-v2.fastpod.net/v1/orders/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reference_id": "20231111",
    "order_status": "draft",
    "boost_production": false,
    "line_items": [
        {
            "item_id": "1",
            "sku": "UTNGDT1W00L",
            "name": "Item 1",
            "quantity": 3,
            "print_areas": {
                "front": "https://via.placeholder.com/2400/09f/fff.png",
                "back": "https://via.placeholder.com/2400/09f/fff.png"
            },
            "preview_areas": {
                "front": "https://via.placeholder.com/2400/09f/fff.png",
                "back": "https://via.placeholder.com/2400/09f/fff.png"
            }
        }
    ],
    "address": {
        "name": "Michael Brown",
        "company": "My company",
        "email": "michaelbrown@demo.com",
        "phone": "(330) 829-0294",
        "street1": "3431 Reeves Street",
        "street2": null,
        "city": "Milwaukee",
        "state": "WI",
        "country": "US",
        "zip": "53202"
    },
    "shipping_method": 1
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": true,
    "message": "Order updated successfully.",
    "data": {
        "id": "F237-120723-000001",
        "reference_id": "string",
        "order_status": "new_order",
        "test_order": false,
        "item_total": 14.4,
        "shipping_total": 24,
        "surcharge_total": 0,
        "order_total": 38.4,
        "payment_method": "cash",
        "payment_status": "unpaid",
        "point_earned": 0,
        "point_used": 3840,
        "quantity_total": 1,
        "shipping_method": "3",
        "boost_production": true,
        "gift_message": null,
        "created_at": "2023-12-07T07:54:35.000000Z",
        "updated_at": "2023-12-07T07:54:35.000000Z",
        "rejected_at": null,
        "rejected_status": null,
        "cancelled_at": null,
        "address": {
            "name": "Michael Brown",
            "company": "My company",
            "email": "michaelbrown@demo.com",
            "phone": "(330) 829-0294",
            "street1": "3431 Reeves Street",
            "street2": null,
            "city": "Milwaukee",
            "state": "WI",
            "country": "US",
            "zip": "53202"
        },
        "line_items": [
            {
                "id": 100009,
                "item_id": "string",
                "name": "Line Item 1",
                "sku": "UABSTAQUBXL3",
                "style": "3001",
                "color": "AQUA",
                "size": "3XL",
                "unit_price": 14.4,
                "quantity": 1,
                "point_earned": 1440,
                "price": 14.4,
                "print_areas": {
                    "front": "url"
                },
                "preview_areas": {
                    "front": "url"
                },
                "shipping_price": 24
            }
        ],
        "shipments": []
    }
}

Modified at 2024-01-09 00:24:37

Estimate Item Price

Update Status