FastPOD
  1. Orders
FastPOD
  • Getting Started
  • Orders
    • List Orders
      GET
    • Get Order
      GET
    • Create Order
      POST
    • Cancel Order
      POST
    • Estimate Order Price
      POST
    • Estimate Item Price
      POST
    • Update Order
      PUT
    • Update Status
      PUT
  • Catalog
    • List Catalogs
      GET
  • Webhook
    • List Webhooks
      GET
    • Subscribe
      POST
    • Unsubcribe
      DELETE
  1. Orders

Get Order

GET
/v1/orders/{id}
The API respond with detailed information about the specified order.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Accept
string 
required
Example:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-v2.fastpod.net/v1/orders/' \
--header 'Accept: application/json'

Responses

🟢200OK
application/json
Body
id
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: draft, new_order, on_hold, 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
integer 
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, 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
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.
name
string 
required
company
string 
required
email
string 
required
phone
string 
required
street1
string 
required
street2
string 
required
city
string 
required
state
string 
required
country
string 
required
zip
string 
required
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.
id
integer 
optional
item_id
string 
optional
name
string 
optional
sku
string 
optional
style
string 
optional
color
string 
optional
size
string 
optional
unit_price
integer 
optional
quantity
integer 
optional
point_earned
integer 
optional
price
number 
optional
discount
number 
optional
print_areas
object 
optional
preview_areas
object 
optional
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
Examples
{
  "id": "F237-120723-000001",
  "reference_id": "string",
  "order_status": "cancelled",
  "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-07T08:29:50.000000Z",
  "rejected_at": null,
  "rejected_status": null,
  "cancelled_at": "2023-12-07T08:29:50.000000Z",
  "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,
      "quantity": 1,
      "point_earned": 1440,
      "price": 14.4,
      "print_areas": {
        "front": "url"
      },
      "preview_areas": {
        "front": "url"
      }
    }
  ],
  "shipments": [],
  "discount_total": null
}
🟠422Parameter Error
Modified at 2023-12-18 02:25:59
Previous
List Orders
Next
Create Order
Built with