Editor Shop API Reference 1.0.0 GNU GPLv3

Fasteditor API references for Shop Integrators

Server

https://api.{domain_url}.com/api

https://api.{domain_url}.com/webhook

Server Variables

Authentication

The request needs to include an X-Api-Key header. Make sure this header is not exposed to the browser, so this request needs to be initiated from the backend.

Fields

Key	In
X-Api-Key	Header

Catalogue

Find Products

This API helps you find the Fasteditor SKU for a products when only a partial part of the sku is known.

Note: Kindly contact our team to update your permissions befor using these endpoints.

Auth

Query String

sku	string	Partial SKU to search with
supplier	string	Name of the supplier of the specified SKU

GET /offering/sku

xxxxxxxxxx
 
curl --get \ --url 'https://api.printiki.test.fasteditor.com/api/offering/sku' \ --header 'X-Api-Key: {X-Api-Key}' \ --data sku=10000 \ --data supplier=pfconcepts
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
[ "10000200#1#front#30#70#4", "10000200#1#back#30#70#4", "10000201#1#front#30#70#4", "10000201#1#back#30#70#4", "10000202#1#front#30#70#4", "10000203#1#front#30#70#4", "10000203#1#back#30#70#4", "10000204#1#front#30#70#4", "10000204#1#back#30#70#4"]
Copy

Get Product Details

This endpoint returns details about a product configuration with the Fasteditor SKU

Note: Kindly contact our team to update your permissions befor using these endpoints.

Auth

Query String

sku	string	Complete Fasteditor SKU value
supplier	string	Supplier Name

GET /offering/sku/data

xxxxxxxxxx
 
curl --get \ --url 'https://api.printiki.test.fasteditor.com/api/offering/sku/data' \ --header 'X-Api-Key: {X-Api-Key}' \ --data sku=10000200#1#front#30#70#4 \ --data supplier=PF%20Concept
Copy

Responses

200

Success

No response body

Response

xxxxxxxxxx
 
{ "sku": "10000200_1_4799_34", "output": {  "dpi": 300,  "fileType": "PDF",  "addPreview": "end" }, "content": {  "pages": [   {    "2D": {     "insertX": 86,     "insertY": 396,     "imageUrl": "https://cdn.filestackcontent.com/8J7Bg9I0RmWhM8vRVcj6",     "insertAngle": 0,     "insertWidth": 138,     "insertHeight": 321    },    "3D": {     "sceneUrl": "https://imagedata.pfconcept.com/3d/models/100002/100002.glb",     "textureUrl": "https://imagedata.pfconcept.com/3d/models/100002/textures/10000200.png",     "printMaterialName": "imprint-1_4799_34",     "textureMaterialName": "100002",     "printMaterialTemplate": {      "width": 1024,      "height": 1024,      "insertX": 342,      "insertY": 129,      "insertWidth": 325,      "insertHeight": 767     }    },    "bleed": 0,    "width": 30,    "height": 70   }  ],  "metricUnits": "mm" }, "skuGroup": "100002", "supplier": {  "name": "PFConcepts",  "reference": "10000200_1_4799_34" }, "printMethod": "Pad printing", "productName": "Oregon 400 ml aluminium water bottle with carabiner", "productType": "logoGift", "localization": {  "en": {   "productName": "Oregon 400 ml aluminium water bottle with carabiner",   "productDescription": "Staying hydrated at all times is possible with this durable yet lightweight 400 ml aluminium water bottle. It is the perfect companion while exercising, on day trips or at the office. The single wall Oregon bottle has a twist-on lid and offers plenty of space to add any kind of logo. Clip the attached carabiner (not suitable for climbing) securely to a bag to avoid losing it. BPA Free and tested and approved under German Food Safe Legislation (LFGB) and for phthalates content under  REACH.  "  } }, "schemaVersion": "1.0.0", "productAttributes": {  "printColors": 4,  "productColor": "Pearl",  "printPosition": "front" }, "printColorSpectrum": "pms_4", "productDescription": "Pad printing | pms_4 | Pearl"}
Copy

Expand

Offering Search

Auth

Request Body

object	object
supplier	string	Name of the supplier of the product Enum: `PF Concept`,`Safsira`,`Texam`,`XD Connects`,`HIT`,`Clipper`,`BIC`,`MidOcean`,`Digital On Demand`,`BQS Textiles`,`Ayano Direct`,`Promoplants`,`Lynka`,`Greengiving`,`MOYU`,`LogoChoc`,`Sproutworld`,`TH Clothes`,`Stickercase`,`Goldstar`,`Makito`,`Toppoint`,`Pens.com`,`Printify`,`Stanley/Stella`,`Flyeralarm`,`Promo Sneakers`,`ID Identity`,`Merch Farm`,`Drukbaas`,`AODACI`,`Tradeprint`
skuGroup	string	Name of the SKU Group
printMethod	string	One of the print methods available in FastEditor. Only ENUM values provided here are valid. Enum: `Bulb printing`,`Debossing`,`Digital printing`,`Digital transfer`,`Doming`,`Embossing`,`Embroidery`,`Engraving`,`Flower printing`,`Hotstamp`,`Laser engraving`,`Pad printing`,`Plant printing`,`Screen printing`,`Screen transfer`,`Sublimation`,`UV printing`
printPosition	string	Name of the print position as defined by Supplier.
printColors	string	Number of print colors available to the customer, or "full-color". Enum: `1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`full-color`
baseSKU	string	The baseSKU usually equals the SKU of the physical product at the Supplier (without specifying printing attributes).
productColor	string	Color variation of the product (in case this is not part of the baseSKU)
supplierPrintMethodName	string	Print method name as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds). Will be ignored in case "supplierPrintMethodCode" property is send in the same request.
supplierPrintMethodCode	string	Print method code as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds)
supplierPrintAreaCodes	array[string]	Array of print position codes as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds). Array should hold values of the print positions that should be available for customization in the Editor.
supplierPrintAreaNames	array[string]	Array of print position names as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds). Array should hold values of the print positions that should be available for customization in the Editor. Will be ignored in case "supplierPrintAreaCodes" property is send in the same request.

Expand

POST /offering/search

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.printiki.test.fasteditor.com/api/offering/search' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "supplier": "PF Concept",  "baseSKU": "10612200",  "supplierPrintMethodCode": "20",  "supplierPrintAreaCodes": [    "bottom left",    "bottom right"  ]}'
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
[
 {...}
]
Copy

Get all product configurations

This endpoint returns a paginated list of all the available product configurations for a specific supplier. The returned data can be used to generate a deeplink to the to preselect the right product configuration on the POST /smartlink endpoint.

The results are paginated with a default limit of 20 and can be controlled by setting the limit, the paginated results are however capped at 1000 results.

The following pagination headers can be found in the response headers.

x-pagination-next, x-pagination-previous, x-total-records.

Auth

Query String

supplier	string	Supplier Name
limit	integer	Used to set the pagination size limit (Default: 20)
offset	integer	Used to determine the starting point of data to fetch.

GET /offering/smartlink

xxxxxxxxxx
 
curl --get \ --url 'https://api.printiki.test.fasteditor.com/api/offering/smartlink' \ --header 'X-Api-Key: {X-Api-Key}' \ --data supplier=PF%20Concept \ --data limit={limit} \ --data offset={offset}
Copy

Responses

200

Success

Root Type for smartlink_offering_body	array[object]
sku	string
baseSKU	string
skuGroup	string
printMethod	string
printPosition	string
printPositions	array[string]
printColors	int32
productColor	string
supplierPrintMethodName	string
supplierPrintMethodCode	string
supplierPrintAreaCodes	array[string]
supplierPrintAreaNames	array[string]

Response

xxxxxxxxxx
 
[
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...},
 {...}
]
Copy

Basic Integration

Create Smartlink

The SmartLink endpoint should be used to send users to FastEditor. If you want the user to start a new project, you provide the SKU or the productAttributes of the product. If you want the user to continue on an existing project, you use the projectId parameter to indicate which project to continue.

Auth

Request Body

Root Type for smartlink_body	object
userId	string	Your internal unique identifier for the user. If this is provided, we will create a user session linked to this user profile.
sku	string	Your internal SKU of the product the user wants to create. Will be ignored in case projectId is set.
language	string	The language in which to show the FastEditor UI.
country	string	The country the user is shopping in.
currency	string	The currency in which to show pricing information in FastEditor.
productOptions	object	Defines if the user can switch between different product options in the editor UI
openOnStart	boolean	Do you want to open the UI for selecting the product options when the editor starts?
enabled	boolean	Enable the UI in the editor for changing the product options?
projectId	integer	Project unique identifier
quantity	integer	When provided, after the user finishes creating the project, it will be added to the shopping cart in this quantity.
cartUrl	string	The shopping cart URL where the user should be send after it completed the design. This is only required if the cart URL is not set on a global level for this shop. Only works when the userId is also provided in the payload.
customAttributes	object	Custom attributes that you want to receive back in the Add to Cart
productAttributes	object	Allows deeplinking to a product based on the "baseSKU" (usually provided by the supplier) and a set of attributes. If a "sku" is provided in the same payload, this will be ignored.
printMethod	string	One of the print methods available in FastEditor. Only ENUM values provided here are valid. Enum: `Bulb printing`,`Debossing`,`Digital printing`,`Digital transfer`,`Doming`,`Embossing`,`Embroidery`,`Engraving`,`Flower printing`,`Hotstamp`,`Laser engraving`,`Pad printing`,`Plant printing`,`Screen printing`,`Screen transfer`,`Sublimation`,`UV printing`
printPosition	string	Name of the print position as defined by Supplier.
printColors	string	Number of print colors available to the customer, or "full-color". Enum: `1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`full-color`
baseSKU	string	The baseSKU usually equals the SKU of the physical product at the Supplier (without specifying printing attributes).
productColor	string	Color variation of the product (in case this is not part of the baseSKU)
supplierPrintMethodName	string	Print method name as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds). Will be ignored in case "supplierPrintMethodCode" property is send in the same request.
supplierPrintMethodCode	string	Print method code as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds)
supplierPrintAreaCodes	array[string]	Array of print position codes as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds). Array should hold values of the print positions that should be available for customization in the Editor.
supplierPrintAreaNames	array[string]	Array of print position names as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds). Array should hold values of the print positions that should be available for customization in the Editor. Will be ignored in case "supplierPrintAreaCodes" property is send in the same request.
supplier	string	Name of the supplier of the product deeplinking to. It's not strictly required, but solves issues if 2 suppliers are using the same sku and is therefore strongly recommended (it may be enforced in the future). Enum: `PF Concept`,`Safsira`,`Texam`,`XD Connects`,`HIT`,`Clipper`,`BIC`,`MidOcean`,`Digital On Demand`,`BQS Textiles`,`Ayano Direct`,`Promoplants`,`Lynka`,`Greengiving`,`MOYU`,`LogoChoc`,`Sproutworld`,`TH Clothes`,`Stickercase`,`Goldstar`,`Makito`,`Toppoint`,`Pens.com`,`Printify`,`Stanley/Stella`,`Flyeralarm`,`Promo Sneakers`,`ID Identity`,`Merch Farm`,`Drukbaas`,`AODACI`,`Tradeprint`
guestUser	boolean	Only for white labels with the Auth Integration module implemented. When the provided userId parameter belongs to an anonymous or "guest" user, this should be set to true. It will enable the login dialog within FastEditor.

Expand

POST /smartlink

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.printiki.test.fasteditor.com/api/smartlink' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "userId": "user_123",  "sku": "BOOK_13x13",  "language": "en",  "country": "US",  "currency": "USD",  "custom_attributes": {},  "quantity": 50,  "productOptions": {    "enabled": true,    "openOnStart": false  }}'
Copy

Responses

200

Root Type for smartlink_body	object
userId	string	Your internal unique identifier for the user. If this is provided, we will create a user session linked to this user profile.
sku	string	Your internal SKU of the product the user wants to create. Will be ignored in case projectId is set.
language	string	The language in which to show the FastEditor UI.
country	string	The country the user is shopping in.
currency	string	The currency in which to show pricing information in FastEditor.
productOptions	object	Defines if the user can switch between different product options in the editor UI
openOnStart	boolean	Do you want to open the UI for selecting the product options when the editor starts?
enabled	boolean	Enable the UI in the editor for changing the product options?
projectId	integer	Project unique identifier
quantity	integer	When provided, after the user finishes creating the project, it will be added to the shopping cart in this quantity.
cartUrl	string	The shopping cart URL where the user should be send after it completed the design. This is only required if the cart URL is not set on a global level for this shop. Only works when the userId is also provided in the payload.
customAttributes	object	Custom attributes that you want to receive back in the Add to Cart
productAttributes	object	Allows deeplinking to a product based on the "baseSKU" (usually provided by the supplier) and a set of attributes. If a "sku" is provided in the same payload, this will be ignored.
printMethod	string	One of the print methods available in FastEditor. Only ENUM values provided here are valid. Enum: `Bulb printing`,`Debossing`,`Digital printing`,`Digital transfer`,`Doming`,`Embossing`,`Embroidery`,`Engraving`,`Flower printing`,`Hotstamp`,`Laser engraving`,`Pad printing`,`Plant printing`,`Screen printing`,`Screen transfer`,`Sublimation`,`UV printing`
printPosition	string	Name of the print position as defined by Supplier.
printColors	string	Number of print colors available to the customer, or "full-color". Enum: `1`,`2`,`3`,`4`,`5`,`6`,`7`,`8`,`9`,`10`,`11`,`12`,`full-color`
baseSKU	string	The baseSKU usually equals the SKU of the physical product at the Supplier (without specifying printing attributes).
productColor	string	Color variation of the product (in case this is not part of the baseSKU)
supplierPrintMethodName	string	Print method name as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds). Will be ignored in case "supplierPrintMethodCode" property is send in the same request.
supplierPrintMethodCode	string	Print method code as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds)
supplierPrintAreaCodes	array[string]	Array of print position codes as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds). Array should hold values of the print positions that should be available for customization in the Editor.
supplierPrintAreaNames	array[string]	Array of print position names as defined in the original supplier data (non-normalized source data, only for suppliers that offer product feeds). Array should hold values of the print positions that should be available for customization in the Editor. Will be ignored in case "supplierPrintAreaCodes" property is send in the same request.
supplier	string	Name of the supplier of the product deeplinking to. It's not strictly required, but solves issues if 2 suppliers are using the same sku and is therefore strongly recommended (it may be enforced in the future). Enum: `PF Concept`,`Safsira`,`Texam`,`XD Connects`,`HIT`,`Clipper`,`BIC`,`MidOcean`,`Digital On Demand`,`BQS Textiles`,`Ayano Direct`,`Promoplants`,`Lynka`,`Greengiving`,`MOYU`,`LogoChoc`,`Sproutworld`,`TH Clothes`,`Stickercase`,`Goldstar`,`Makito`,`Toppoint`,`Pens.com`,`Printify`,`Stanley/Stella`,`Flyeralarm`,`Promo Sneakers`,`ID Identity`,`Merch Farm`,`Drukbaas`,`AODACI`,`Tradeprint`
guestUser	boolean	Only for white labels with the Auth Integration module implemented. When the provided userId parameter belongs to an anonymous or "guest" user, this should be set to true. It will enable the login dialog within FastEditor.

Expand

Response

xxxxxxxxxx
 
{    "URL": "https://{{your_brand}}.fasteditor.com/app/create/0/10110011?locale=en&countryid=1&currency=USD&user_token=abcdefghijklmnopqrstuvwxyz}
Copy

Sale Notification

After the customer has placed its order in your webshop, call this endpoint to let FastEditor know that the print files should be generated.

Auth

Request Body

Root Type for notifyorder_body	object
orderId	string	Your Internal Order Identifier
orderItems	object	Order Items
projectKey	integer	The Project Key as shared by FastEditor in the add-to-cart API call
orderItemId	string	Your internal Unique Identifier for the order item
quantity	integer	In what quantity this order item was ordered
totalSaleValue	number	Total sale value of the order item
additionalData	object	For additionalData to be added to the orderItem
barcodeData	string	This can be used for printers/partners that need to print barcodes on their products.
customDataForProof	string	The value submitted for this property will be added to the info table in the proof page of the print document.
billingInfo	object	Billing information of the customer. Only important when using FastEditor to submit orders to supplier directly.
name	string
email	string
address1	string
address2	string
city	string
zip	string
country	string
shippingInfo	object	Shipping destination for the order. Only important when using FastEditor to submit orders to supplier directly.
name	string
email	string
address1	string
address2	string
city	string
zip	string
country	string
callbackUrl	string	Optional Callback URL where orderitems print ready files can be sent after processing.

Expand

POST /notifyorder

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.printiki.test.fasteditor.com/webhook/notifyorder' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "orderId": "2024-05-24T18:51:24-7716011",  "orderItems": [    {      "projectKey": 916,      "orderItemId": "6750898",      "quantity": 1    },    {      "projectKey": 917,      "orderItemId": "6750899",      "quantity": 1    },    {      "projectKey": 920,      "orderItemId": "6750900",      "quantity": 1    },    {      "projectKey": 930,      "orderItemId": "6750901",      "quantity": 1    },    {      "projectKey": 931,      "orderItemId": "6750902",      "quantity": 1    },    {      "projectKey": 932,      "orderItemId": "6750903",      "quantity": 1    }  ]}'
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
No response
Copy

Editor Shop API Reference 1.0.0GNU GPLv3

Authentication

Catalogue

Find Products

Get Product Details

Offering Search

Get all product configurations

Basic Integration

Create Smartlink

Sale Notification

Editor Shop API Reference 1.0.0 GNU GPLv3