Update Status - FastPOD

Update order status

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

string

required

The order ID that is generated by FASTPOD

Header Params

string

required

Example:

application/json

Body Params application/json

order_status

string

required

Only allowed to change the order status from draft or on_hold to new_order.

Example

{
  "order_status": "new_order"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

boolean

required

message

string

required

data

object

required

string

required

The order ID that is generated by FASTPOD

order_type

string

required

Regular order: 1, Label order: 2

reference_id

string

required

A unique value that you generate when you place an order

order_status

string

required

Order status: new_order, draft, in_production, shipped, cancelled, rejected

test_order

boolean

required

When the parameter is set to TRUE, the test order functionality is activated, and test orders are not meant for fulfillment or billing

item_total

number

required

The total cost of all items in the order

shipping_total

integer

required

The total shipping cost

surcharge_total

integer

required

The boost production fee

labeling_fee

integer

required

Labeling fee, only applicable to label orders

peak_season_surchage

integer

required

Peak season surcharge applies only during the peak season

order_total

number

required

The total cost of the order includes the cost of items, shipping, and rush production (if applicable)

payment_method

string

required

The payment methods include 'cash' and 'point'

payment_status

string

required

The payment status includes "paid" (indicating the order has been paid) and "unpaid" (signifying that the order has not been paid).

point_earned

integer

required

The points that a user is rewarded when participating in the Rocket Fuel Program and paying for an order in 'cash'

point_used

integer

required

The points that will be deducted from the user's account when they use 'point' as the payment method for an order

quantity_total

integer

required

The total number of items in the order

shipping_method

string

required

Standard: 1, Priority: 2, Express: 3

rush_production

boolean

required

A boolean flag is initially set to false. If set to true, it might indicate an expedited or boosted production process and can only be set to true for orders with one item.

gift_message

null

required

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

tax_id

null

required

A tax identification number

tax_id_type

null

required

The tax ID type to be shown on the shipping label, such as VAT, EORI, IOSS, or any relevant tax type

created_at

string

required

The time when the order is created

updated_at

string

required

The time when the order is updated

rejected_at

null

required

The time when the order is rejected

rejected_status

null

required

Details when an order is rejected

cancelled_at

null

required

The time when the order is cancelled

address

object

required

The address information of the recipient, including name, email, company, phone, street details, city, state, country, and zip code.

line_items

array [object {14}]

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.

shipments

array[string]

required

The shipping information, which includes the carrier, tracking ID, status, etc., will be provided when the order is shipped.

label_url

string

required

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

coupon_code

string

required

A coupon code that will grant a discount on production cost or labeling fee

discount_total

integer

required

The discount amount of production cost when using a coupon

discount_labeling_fee

integer

required

The discount amount of labeling fee when using a coupon

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,
    "tax_id": null,
    "tax_id_type": 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": []
  }
}