Update order with the Printful API
Changes an order that was not submitted for fulfillment yet and returns it. Send only the fields that change; sending items replaces the item list. Nothing is charged until Confirm order.
- Identifier
- printful_update_order
The request
POST https://connect.reportei.com/api/tools/printful_update_order/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Id of an order from List orders, or the external_id of the order prefixed with @. |
| external_id | string | No | Your own id for the order, unique in the store. |
| shipping | string | No | Shipping method: the id of a rate from Calculate shipping rates, such as STANDARD. |
| recipient | object | No | Delivery address. country_code is a two-letter ISO code; state_code is required for the US, Canada and Australia, and tax_number for Brazil. |
| items | array | No | The new item list. An item with the id of an existing line item from Get order changes it, an existing item left out is removed, and an item without id is added. Each new item names the product with variant_id, sync_variant_id or external_variant_id. |
| retail_costs | object | No | Retail amounts printed on the packing slip of international shipments. Used only when every item has retail_price. |
| gift | object | No | Gift message printed on the packing slip. |
| packing_slip | object | No | Custom packing slip for this order. Give at least one of email, phone, message or custom_order_id. |
Supported connections
Your customer connects their Printful account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/printful_update_order. It becomes your agent's tool definition with no conversion.
Other Printful tools
- List ordersGETLists the orders of the store with status, recipient, items, costs and shipments. Pages with offset and limit; paging.total in the response is the number of orders.
- Get orderGETReturns one order with its status, recipient, items, costs and the shipments with carrier and tracking number.
- Create orderPOSTCreates an order as a draft and returns it with the costs Printful calculated. Nothing is charged until Confirm order. recipient and items are required, and print files are downloaded from public URLs.
- Confirm orderPOSTSubmits a draft order for fulfillment and returns it. Printful charges the billing method of the store owner at this moment; a pending order can still be canceled with Cancel order.
- Cancel orderDELETECancels a draft or pending order and returns it. A charged amount goes back to the card of the store owner. Orders in review, in process or already shipped cannot be canceled.
- Calculate shipping ratesPOSTReturns the shipping methods for a list of items and a destination, with rate, currency and delivery estimate. The id of a method goes in shipping of Create order and Update order. Call it right before ordering, because rates change.
- List catalog productsGETLists the blank products of the Printful catalog, such as t-shirts, mugs and posters, with id, title, type, brand and main_category_id. Get catalog product returns the variants of one of them.
- Get catalog productGETReturns a catalog product and its variants. Each variant has the id that orders and shipping rates take as variant_id, with size, color, price and stock; the product lists the print file placements (files) and options it accepts.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
