Printful

App · 20 actions

Browse Printful products and stores, estimate shipping and costs, and create, update or cancel unconfirmed draft orders.

Actions

ActionWhat it does
Cancel draft orderCancel draft order.
Create draft orderCreate draft order.
Estimate order costsEstimate order costs.
Get catalog productGet catalog product.
Get catalog variantGet catalog variant.
Get fileGet file.
Get orderGet order.
Get shipping ratesGet shipping rates.
Get storeGet store.
Get store productGet store product.
Get store variantGet store variant.
Get warehouse productGet warehouse product.
List catalog productsList catalog products.
List countriesList countries.
List ordersList orders.
List store productsList store products.
List storesList stores.
List tax countriesList tax countries.
List warehouse productsList warehouse products.
Update draft orderUpdate draft order.

Cancel draft order

Cancel draft order.

Inputs

Draft orderorder_idtextRequired
Draft order.
Storestore_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

Storestore_idnumber
Store.At least 1.
Recipient namerecipient_nametextRequired
Recipient name.
Street addressaddress1textRequired
Street address.
Apartment or suiteaddress2text
Apartment or suite.
CitycitytextRequired
City.
Countrycountry_codetextRequired
Country.
State or provincestate_codetext
State or province code.
Postal codeziptextRequired
Postal code.
Recipient emailemailtext
Recipient email.
ItemsitemslistRequired
Each item needs a quantity and either a store sync_variant_id or a catalog variant_id with print files.
External idexternal_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

Storestore_idnumber
Store.At least 1.
Recipient namerecipient_nametextRequired
Recipient name.
Street addressaddress1textRequired
Street address.
Apartment or suiteaddress2text
Apartment or suite.
CitycitytextRequired
City.
Countrycountry_codetextRequired
Country.
State or provincestate_codetext
State or province code.
Postal codeziptextRequired
Postal code.
Recipient emailemailtext
Recipient email.
ItemsitemslistRequired
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 productproduct_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 idvariant_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 idfile_idtextRequired
File id.
Storestore_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

Orderorder_idtextRequired
Order.
Storestore_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

Storestore_idnumber
Store.At least 1.
Recipient namerecipient_nametextRequired
Recipient name.
Street addressaddress1textRequired
Street address.
Apartment or suiteaddress2text
Apartment or suite.
CitycitytextRequired
City.
Countrycountry_codetextRequired
Country.
State or provincestate_codetext
State or province code.
Postal codeziptextRequired
Postal code.
Recipient emailemailtext
Recipient email.
ItemsitemslistRequired
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

Storestore_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 productsync_product_idtextRequired
Store product.
Storestore_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 idvariant_idtextRequired
Variant id.
Storestore_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 idwarehouse_product_idtextRequired
Warehouse product id.
Storestore_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

Storestore_idnumber
Store.At least 1.
Statusstatustext
Status.One of: draft, pending, failed, canceled, inprocess, onhold, partial, fulfilled, archived.
Limitlimitnumber
Limit.From 1 to 100.
Offsetoffsetnumber
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

Storestore_idnumber
Store.At least 1.
Limitlimitnumber
Limit.From 1 to 100.
Offsetoffsetnumber
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

Storestore_idnumber
Store.At least 1.
Limitlimitnumber
Limit.From 1 to 100.
Offsetoffsetnumber
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 orderorder_idtextRequired
Draft order.
Storestore_idnumber
Store.At least 1.
Recipient namerecipient_nametext
Recipient name.
Street addressaddress1text
Street address.
Apartment or suiteaddress2text
Apartment or suite.
Citycitytext
City.
Countrycountry_codetext
Country.
State or provincestate_codetext
State or province code.
Postal codeziptext
Postal code.
Recipient emailemailtext
Recipient email.
Itemsitemslist
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"
    }
  }
}

On this page