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

Create Order

POST
/v1/orders

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
Body Params application/json
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 
optional
The order status can be either 'draft' or 'new_order.' In the 'draft' status, it can be edited without triggering payment and production. Once it transitions to the 'new_order' status, the payment is automatically processed, and the order proceeds to production. The 'new_order' status still allows modifications such as changing quantity, size, or adding more items. In such cases, the system will recalculate the cost and prompt a new payment.
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
shipping_method
integer 
required
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
string 
optional
This field is exclusively meant for gift messages. Your message will be presented on the template we supply.
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 
optional
phone
string 
required
street1
string 
required
street2
string 
optional
city
string 
required
state
string 
required
Require 'state' only when the 'country' is the United States
country
string 
required
zip
string 
required
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).
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 production cost or labeling fee
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": "url",
        "back": "url"
      },
      "preview_areas": {
        "front": "url",
        "back": "url"
      }
    }
  ],
  "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,
  "gift_message": "string",
  "tax_id": "string",
  "tax_id_type": "string"
}

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 POST '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": "url",
                "back": "url"
            },
            "preview_areas": {
                "front": "url",
                "back": "url"
            }
        }
    ],
     "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,
    "gift_message": "string",
    "tax_id": "string",
    "tax_id_type": "string"
}'

Responses

🟢200Success
application/json
Body
status
boolean 
required
message
string 
required
data
object 
required
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
The order status you chose when creating an order (draft or new_order)
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 items in the order
shipping_total
number 
required
The total shipping cost
surcharge_total
integer 
required
The rush 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 'points.' If payment is made in cash and the user participates in the Rocket Fuel Program, they will receive points directly added to their account
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
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
null 
required
This field is exclusively meant for gift messages. Your message will be presented on the template we supply.
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.
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
Examples
{
  "status": true,
  "message": "Order created successfully.",
  "data": {
    "id": "F255-010524-000001",
    "reference_id": "string",
    "order_status": "new_order",
    "test_order": false,
    "item_total": 16.8,
    "shipping_total": 4.99,
    "order_total": 21.79,
    "payment_method": "cash",
    "payment_status": "unpaid",
    "point_earned": 0,
    "point_used": 2179,
    "quantity_total": 1,
    "shipping_method": "1",
    "rush_production_price": 0,
    "rush_production": false,
    "gift_message": null,
    "tax_id": null,
    "tax_id_type": null,
    "created_at": "2024-01-05T02:50:03.000000Z",
    "updated_at": "2024-01-05T02:50:03.000000Z",
    "rejected_at": null,
    "rejected_reason": null,
    "cancelled_at": null,
    "address": {
      "name": "string",
      "company": "string",
      "email": "email",
      "phone": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "state": "string",
      "country": "US",
      "zip": "string"
    },
    "line_items": [
      {
        "print_areas": {
          "front": "url",
          "back": "url"
        },
        "preview_areas": {
          "front": "url"
        },
        "id": 100539,
        "item_id": "string",
        "name": "string",
        "sku": "UABSTBLCKEXS",
        "style": "3001",
        "color": "BLACK",
        "size": "XS",
        "unit_price": 16.8,
        "quantity": 1,
        "point_earned": 0,
        "price": 16.8,
        "discount": 0,
        "product_name": "UNISEX JERSEY SHORT SLEEVE TEE",
        "shipping_price": 4.99
      }
    ],
    "shipments": [],
    "coupon_code": null,
    "discount_total": 0,
    "labeling_fee": 0,
    "order_type": 1,
    "discount_labeling_fee": 0,
    "apply_coupon": false,
    "message_coupon": "The coupon code is invalid"
  }
}
🟠422Parameter Error
Modified at 2024-01-09 00:33:37
Previous
Get Order
Next
Cancel Order
Built with