Update Order - FastPOD

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

id

string

required

The order ID that is generated by FASTPOD

Header Params

Accept

string

required

Example:

application/json

Body Params application/json

reference_id

string

required

A unique value that you generate when you place an order

order_status

string

required

The order can only be updated when it is in the draft, new_order, or on_hold status.

shipping_method

integer

required

Standard: 1, Priority: 2, Express: 3, Prime: 4

rush_production

boolean

required

A boolean flag is initially set to false. If it is set to true, this indicates a rush production process. Rush production is only available for specific products and single-item orders.

gift_message

string

optional

This field is exclusively meant for gift messages. Your message will be presented on the template we supply.

line_items

array [object {6}]

required

Contains details about the items included in the order. In this example, it includes one item with details such as item ID, SKU, name, quantity, print areas, and preview areas.

item_id

string

required

A value that you supply to track line items

sku

string

required

The SKU for the item variant to fulfill. You can access all available IDs for an item in the Fastpod catalog.

name

string

optional

Your product name (optional)

quantity

integer

required

The number of items to fulfill. Should be equal to or greater than 1

print_areas

object

required

Array of print images on the product. Each product will support various printing areas; for specific details, please refer to the Fastpod catalog. The possible values include: front, back, pocket, neck_label, right_sleeve, left_sleeve.

preview_areas

object

optional

Array of attached preview images (optional).

address

object

required

The address information of the recipient is only required when the order type is 1 (regular order)

name

string

required

email

string

required

company

string

required

phone

string

required

street1

string

required

street2

string

required

city

string

required

state

string

required

country

string

required

zip

string

required

tax_id

string

optional

A tax identification number. This field is required when there is a value present in the 'tax_id_type' field

tax_id_type

string

optional

The tax ID type to be shown on the shipping label, such as VAT, EORI, IOSS, or any relevant tax type .This field is required when there is a value present in the 'tax_id' field

coupon_code

string

optional

A coupon code that will grant a discount on certain specific items

label_url

string

required

The shipping label URL is required only when the order type is 2 (label order)

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 samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

status

boolean

required

message

string

required

data

object

required

id

string

required

order_type

string

required

reference_id

string

required

order_status

string

required

test_order

boolean

required

item_total

number

required

shipping_total

integer

required

surcharge_total

integer

required

labeling_fee

integer

required

peak_season_surchage

integer

required

order_total

number

required

payment_method

string

required

payment_status

string

required

point_earned

integer

required

point_used

integer

required

quantity_total

integer

required

shipping_method

string

required

rush_production

boolean

required

gift_message

null

required

created_at

string

required

updated_at

string

required

rejected_at

null

required

rejected_status

null

required

cancelled_at

null

required

address

object

required

line_items

array [object {14}]

required

shipments

array[string]

required

label_url

string

required

coupon_code

string

optional

discount_total

integer

optional

discount_labeling_fee

integer

optional

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": []
    }
}