Printful
App · 20 actions
Browse Printful products and stores, estimate shipping and costs, and create, update or cancel unconfirmed draft orders.
Actions
| Action | What it does |
|---|---|
| Cancel draft order | Cancel draft order. |
| Create draft order | Create draft order. |
| Estimate order costs | Estimate order costs. |
| Get catalog product | Get catalog product. |
| Get catalog variant | Get catalog variant. |
| Get file | Get file. |
| Get order | Get order. |
| Get shipping rates | Get shipping rates. |
| Get store | Get store. |
| Get store product | Get store product. |
| Get store variant | Get store variant. |
| Get warehouse product | Get warehouse product. |
| List catalog products | List catalog products. |
| List countries | List countries. |
| List orders | List orders. |
| List store products | List store products. |
| List stores | List stores. |
| List tax countries | List tax countries. |
| List warehouse products | List warehouse products. |
| Update draft order | Update draft order. |
Cancel draft order
Cancel draft order.
Inputs
- Draft order
order_idtextRequired - Draft order.
- Store
store_idnumber - Store.At least 1.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"result": {
"id": 1,
"items": [],
"recipient": {
"name": "example"
},
"status": "example"
}
}
}Create draft order
Create draft order.
Inputs
- Store
store_idnumber - Store.At least 1.
- Recipient name
recipient_nametextRequired - Recipient name.
- Street address
address1textRequired - Street address.
- Apartment or suite
address2text - Apartment or suite.
- City
citytextRequired - City.
- Country
country_codetextRequired - Country.
- State or province
state_codetext - State or province code.
- Postal code
ziptextRequired - Postal code.
- Recipient email
emailtext - Recipient email.
- Items
itemslistRequired - Each item needs a quantity and either a store sync_variant_id or a catalog variant_id with print files.
- External id
external_idtext - External id.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"result": {
"id": 1,
"items": [],
"recipient": {
"name": "example"
},
"status": "example"
}
}
}Estimate order costs
Estimate order costs.
Inputs
- Store
store_idnumber - Store.At least 1.
- Recipient name
recipient_nametextRequired - Recipient name.
- Street address
address1textRequired - Street address.
- Apartment or suite
address2text - Apartment or suite.
- City
citytextRequired - City.
- Country
country_codetextRequired - Country.
- State or province
state_codetext - State or province code.
- Postal code
ziptextRequired - Postal code.
- Recipient email
emailtext - Recipient email.
- Items
itemslistRequired - Each item needs a quantity and either a store sync_variant_id or a catalog variant_id with print files.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"result": {
"costs": {
"currency": "example",
"total": "example"
}
}
}
}Get catalog product
Get catalog product.
Inputs
- Catalog product
product_idtextRequired - Catalog product.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": {
"product": {
"id": 1
},
"variants": []
}
}
}Get catalog variant
Get catalog variant.
Inputs
- Variant id
variant_idtextRequired - Variant id.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": {}
}
}Get file
Get file.
Inputs
- File id
file_idtextRequired - File id.
- Store
store_idnumber - Store.At least 1.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": {}
}
}Get order
Get order.
Inputs
- Order
order_idtextRequired - Order.
- Store
store_idnumber - Store.At least 1.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": {
"id": 1,
"items": [],
"recipient": {
"address1": "example",
"address2": "example",
"city": "example",
"country_code": "example",
"email": "example",
"name": "example",
"state_code": "example",
"zip": "example"
},
"status": "example"
}
}
}Get shipping rates
Get shipping rates.
Inputs
- Store
store_idnumber - Store.At least 1.
- Recipient name
recipient_nametextRequired - Recipient name.
- Street address
address1textRequired - Street address.
- Apartment or suite
address2text - Apartment or suite.
- City
citytextRequired - City.
- Country
country_codetextRequired - Country.
- State or province
state_codetext - State or province code.
- Postal code
ziptextRequired - Postal code.
- Recipient email
emailtext - Recipient email.
- Items
itemslistRequired - Each item needs a quantity and either a store sync_variant_id or a catalog variant_id with print files.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"result": []
}
}Get store
Get store.
Inputs
- Store
store_idtextRequired - Store id.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": {}
}
}Get store product
Get store product.
Inputs
- Store product
sync_product_idtextRequired - Store product.
- Store
store_idnumber - Store.At least 1.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": {
"sync_product": {
"id": 1
},
"sync_variants": []
}
}
}Get store variant
Get store variant.
Inputs
- Variant id
variant_idtextRequired - Variant id.
- Store
store_idnumber - Store.At least 1.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": {
"files": [],
"id": 1,
"variant_id": 1
}
}
}Get warehouse product
Get warehouse product.
Inputs
- Warehouse product id
warehouse_product_idtextRequired - Warehouse product id.
- Store
store_idnumber - Store.At least 1.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": {}
}
}List catalog products
List catalog products.
Inputs
None.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": []
}
}List countries
List countries.
Inputs
None.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": []
}
}List orders
List orders.
Inputs
- Store
store_idnumber - Store.At least 1.
- Status
statustext - Status.One of:
draft,pending,failed,canceled,inprocess,onhold,partial,fulfilled,archived. - Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": []
}
}List store products
List store products.
Inputs
- Store
store_idnumber - Store.At least 1.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": []
}
}List stores
List stores.
Inputs
None.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": []
}
}List tax countries
List tax countries.
Inputs
None.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": []
}
}List warehouse products
List warehouse products.
Inputs
- Store
store_idnumber - Store.At least 1.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"paging": {
"limit": 1,
"offset": 1,
"total": 1
},
"result": []
}
}Update draft order
Update draft order.
Inputs
- Draft order
order_idtextRequired - Draft order.
- Store
store_idnumber - Store.At least 1.
- Recipient name
recipient_nametext - Recipient name.
- Street address
address1text - Street address.
- Apartment or suite
address2text - Apartment or suite.
- City
citytext - City.
- Country
country_codetext - Country.
- State or province
state_codetext - State or province code.
- Postal code
ziptext - Postal code.
- Recipient email
emailtext - Recipient email.
- Items
itemslist - Each item needs a quantity and either a store sync_variant_id or a catalog variant_id with print files.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"code": 1,
"result": {
"id": 1,
"items": [],
"recipient": {
"name": "example"
},
"status": "example"
}
}
}