List Orders - FastPOD

The API responds with a paginated list of orders based on the provided parameters.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

page

string

optional

A page number within the paginated result set.

Example:

limit

string

optional

Number of results to return per page.

Example:

status

string

optional

Filter by order status. Possible values: draft, new_order, on_hold, in_production, shipped, cancelled, rejected

string

optional

FASTPOD order number or Reference number to search for.

start_date

string

optional

The starting date for filtering the results. This parameter is optional.
Example: 2023-01-01

end_date

string

optional

The ending date for filtering the results. This parameter is optional.
Example: 2023-12-31

shipping_method

string

optional

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

order_type

string

optional

Regular order: 1, Label order: 2

payment_method

string

optional

Filter by payment method. Possible values: cash, point

payment_status

string

optional

Filter by payment status. Possible values: paid, unpaid

Header Params

string

required

Example:

application/json

Body Params application/x-www-form-urlencoded

object {0}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200List Orders

application/json

Body

current_page

integer

required

data

array [object {31}]

required

string

optional

The order ID that is generated by FASTPOD

order_type

string

optional

Regular order: 1, Label order: 2

reference_id

string

optional

A unique value that you generate when you place an order

order_status

string

optional

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

test_order

boolean

optional

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

integer

optional

The total cost of all items in the order

shipping_total

integer

optional

The total shipping cost

surcharge_total

integer

optional

The rush production fee

labeling_fee

integer

optional

Labeling fee, only applicable to label orders

peak_season_surchage

integer

optional

Peak season surcharge applies only during the peak season

order_total

integer

optional

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

payment_method

string

optional

The payment methods include 'cash' and 'point'

payment_status

string

optional

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

point_earned

integer

optional

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

point_used

integer

optional

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

optional

The total number of items in the order

shipping_method

string

optional

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

rush_production

boolean

optional

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

null

optional

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

created_at

string

optional

The time when the order is created

updated_at

string

optional

The time when the order is updated

rejected_at

null

optional

The time when the order is rejected

rejected_status

null

optional

Details when an order is rejected

cancelled_at

null

optional

The time when the order is cancelled

address

object

optional

The information of the recipient

line_items

array [object {12}]

optional

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]

optional

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

label_url

string

optional

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

coupon_code

string

optional

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

discount_total

integer

optional

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

next_page_url

string

required

path

string

required

per_page

integer

required

prev_page_url

null

required

integer

required

total

integer

required

Example

{
    "current_page": 1,
    "data": [
        {
            "id": "FAS105-111423-000006",
            "reference_id": "20231111",
            "order_status": "draft",
            "test_order": false,
            "item_total": 36,
            "shipping_total": 8,
            "surcharge_total": 0,
            "order_total": 44,
            "payment_method": "cash",
            "payment_status": "unpaid",
            "point_earned": 0,
            "point_used": 0,
            "quantity_total": 0,
            "shipping_method": "1",
            "boost_production": false,
            "gift_message": null,
            "created_at": "2023-11-14T10:17:10.000000Z",
            "updated_at": "2023-11-14T10:17:10.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": 5207,
                    "item_id": "1",
                    "name": "Item 1",
                    "sku": "UNGT1W00L",
                    "style": "5000",
                    "color": "WHITE",
                    "size": "L",
                    "unit_price": 12,
                    "quantity": 3,
                    "price": 36,
                    "print_areas": {
                        "front": "url",
                        "back": "url"
                    },
                    "preview_areas": {
                        "front": "url",
                        "back": "url"
                    }
                }
            ],
            "shipments": []
        }
    ],
    "next_page_url": "http://api-v2.fastpod.net/v1/orders?page=1&limit=251",
    "path": "http://api-v2.fastpod.net/v1/orders?page=1&limit=25",
    "per_page": 25,
    "prev_page_url": null,
    "to": 25,
    "total": 1
}