Orders API
The Orders API allows you to create new orders and confirm them for fulfillment.
PrintfulStoreClient.orders
Get list of orders
Returns list of order objects from your store
Method
PrintfulStoreClient.orders.getAllOrders(offset?: number, limit?: number, status?: OrderStatus)
Arguments
Optional status - Filter by order status
Optional offset - Result set offset
Optional limit - Number of items per page (max 100)
Example Usage:
//Soon to be added
Create a new order
Creates a new order and optionally submits it for fulfillment
Method
PrintfulStoreClient.orders.createOrder(newOrder: Order, confirm?: boolean, update_existing?: boolean)
Arguments
newOrder - information about new order
Optional confirm - Automatically submit the newly created order for fulfillment (skip the Draft phase)
Optional update_existing - Try to update existing order if an order with the specified external_id already exists
Example Usage:
//Soon to be added
Get order data
Returns order data by ID or External ID.
Method
PrintfulStoreClient.orders.getOrder(id: number | string)
Arguments
id - Order ID (integer) or External ID (if prefixed with @)
Example Usage:
//Soon to be added
Cancel an order
Cancels pending order or draft. Charged amount is returned to the store owner's credit card.
Method
PrintfulStoreClient.orders.cancelOrder(id: number | string)
Arguments
id - Order ID (integer) or External ID (if prefixed with @)
Example Usage:
//Soon to be added
Update order data
Updates unsubmitted order and optionally submits it for the fulfillment.
Method
PrintfulStoreClient.orders.updateOrder(id: number | string, orderData: Order, confirm?: boolean)
Arguments
id - Order ID (integer) or External ID (if prefixed with @)
orderData - Update information about the order
Optional confirm - Automatically submit the newly created order for fulfillment (skip the Draft phase)
Example Usage:
//Soon to be added
Confirm draft for fulfillment
Approves for fulfillment an order that was saved as a draft. Store owner's credit card is charged when the order is submitted for fulfillment.
Method
PrintfulStoreClient.orders.confirmOrder(id: number | string)
Arguments
id - Order ID (integer) or External ID (if prefixed with @)
Example Usage:
//Soon to be added
Estimate order costs
Calculates the estimated order costs including item costs, print costs (back prints, inside labels etc.), shipping and taxes
Method
PrintfulStoreClient.orders.estimateOrderCost(orderData: Order)
Arguments
orderData - Information on order for which estimate will be returned
Example Usage:
//Soon to be added