Fulfillment API Documentation 1.0.0 GNU GPLv3

Fasteditor Order fulfillment service API references

Server

https://fulfillment.{api_environment}.fasteditor.com/{version}

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

Sale Notification Webhook

Auth

Path Params

partnerid

integer

Partner Id

Request Body

Root Type for sale_notification_body	object	Sale notification body
orderId	string	The unique id for the order as defined by Partner
orderItems	array[object]	Array with the items in the order that were created in the FastEditor
projectKey	int32	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	int32	In what quantity was this 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.
billingInfo	object
name	string
email	string
address1	string
address2	string
city	string
state	string
zip	string
country	string
phone	string
shippingInfo	object
name	string
address1	string
address2	string
city	string
state	string
zip	string
country	string
phone	string
paymentMethod	string	The Method used by user to make payment
trackShipping	boolean	Has the user opted to be able to track shipping status of thier order

Expand

POST /webhook/partner/{partnerid}/notifyorder

xxxxxxxxxx
 
curl --request POST \ --url 'https://fulfillment.test.fasteditor.com/v1.0/webhook/partner/%7Bpartnerid%7D/notifyorder' \ --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

201

Success

No response body

Response

xxxxxxxxxx
 
{}
Copy

HelloPrint - Change SKUs

HelloPrint only - Request change of SKU used for a product

Auth

Request Body

Root Type for updateSKU	object	Update the SKU
newSku	string
oldSku	string
publish	boolean	Specify if the sku should be updated in production immediately

PUT /api/helloprint/sku

xxxxxxxxxx
 
curl --request PUT \ --url 'https://fulfillment.test.fasteditor.com/v1.0/api/api/helloprint/sku' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "oldSku": "some text",  "newSku": "some other text"}'
Copy

Responses

200

success

No response body

Response

xxxxxxxxxx
 
No response
Copy

HelloPrint - Add New SKUs

HelloPrint only - Request to add new SKUs to platform

Auth

Request Body

Root Type for add_offering	array[object]
groupName	string	Group identifier for SKU. This should be used to group multiple SKUs together, such a color variations for the same product. Translates to "slug" parameter used internally by HelloPrint.
skus	array[string]	Array of SKU strings

POST /api/helloprint/sku

xxxxxxxxxx
 
curl --request POST \ --url 'https://fulfillment.test.fasteditor.com/v1.0/api/api/helloprint/sku' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '[  {    "groupName": "some text",    "skus": [      "some text",      "some text"    ]  },  {    "groupName": "some text",    "skus": [      "some text",      "some text"    ]  }]'
Copy

Responses

202

Success

No response body

400

Bad request

Response

xxxxxxxxxx
 
No response
Copy

Fulfillment API Documentation 1.0.0GNU GPLv3

Authentication

Sale Notification Webhook

HelloPrint - Change SKUs

HelloPrint - Add New SKUs

Fulfillment API Documentation 1.0.0 GNU GPLv3