The Frame It Easy API lets you drop ship custom frames in any size including art and photo prints. Our drop shipping is only available in the US. The API allows endpoint requests and responses for all data required to make your picture frames - including users, frame products, items, orders, fulfillment and other information objects related to collecting and manufacturing custom picture frames. The datasets are organized in after a customer has made design changes in Step 1API request URL paths with well-formed JSON response objects. API requests handle json encoded POST fields. The Postman examples and documentation below covers the entire API functionality.
\nOne API workflow that is commonly used: a user is created, the user will design a picture frame, the picture frame product is saved for the user, the user sells the picture frame. The sold picture frame is added to an Order object, then the order is fulfilled by the Frame It Easy manufacturing. Once the Order is shipped a fulfillment Object is available in the API.
\nAnother API workflow is that a user is created and the user designs custom frames without saving them as products. With this set up, a custom size frame is designed on the fly using the API item Object. The item can be an unlimited combination of frame styles, sizes, matting, paper type and image print. Once the Order object is processed, the frame is manufactured, shipped and then the fulfillment Object with shipping information is available from the API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7462304","collectionId":"6184c82d-8696-4136-a6a7-5c7059597ae9","publishedId":"Tz5s3bQB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-04-01T17:35:52.000Z"},"item":[{"name":"Items","id":"30b41480-3189-4a4c-bad6-beb630e79c4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"sandbox@frameiteasy.com:0Az9*MtXQo"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.sandbox.frameiteasy.com/v1/items","description":"Response with all the product Items for a complete frame. The result shows the frame styles, colors, covers, backings and mat boards. The Items selections become parameters for building a completed picture frame that can be saved as an Order.
\n
\nItems Values
| styles | \n\n | \n | Frame profile attributes. | \n
| \n | profile_name | \n\n | Profile names are Hanover, Derby, Dayton, Hanover, Granby, Ashford, Hammond, Bradford, Stafford. | \n
| \n | color_name | \n\n | Profile color name. | \n
| \n | profile_width_num | \n\n | The wholenumber size of the viewble face of the frame. | \n
| \n | profile_width_frac | \n\n | The fractional size of the viewble face of the frame. | \n
| \n | profile_min_width_num | \n\n | The wholenumber smallest size of the frame rail we can cut with our saw. | \n
| \n | profile_min_width_frac | \n\n | The fractional smallest size of the frame rail we can cut with our saw. | \n
| \n | profile_max_width_num | \n\n | The wholenumber longest size of the frame rail we can cut with our saw. | \n
| \n | profile_max_width_frac | \n\n | The fractional longest size of the frame rail we can cut with our saw. | \n
| \n | profile_max_width_complete | \n\n | The wholenumber longest frame width we can sell with the longest height. | \n
| \n | profile_max_height_complete | \n\n | The wholenumber longest frame height we can sell with the longest width. | \n
| covers | \n\n | \n | Frame cover items. | \n
| \n | cover_name | \n\n | The names of the available frame covers. Clear Acrylic, Non-Glare Acrylic, Conservation Clear Acrylic, and No Cover. | \n
| backings | \n\n | \n | Frame backing items. | \n
| \n | backing_name | \n\n | The names of the available frame backings. Acid Free Foamcore, Standard Foamcore, No Backing. | \n
| mats | \n\n | \n | Frame mat items. | \n
| \n | mat_design_name | \n\n | The names of the available mat boards. The most popular are Smooth White and Smooth Black with White Core. | \n
A sku value can retrieve the item dataset with frame information. The item dataset includes all values about the frame including the price. Another method for retrieving the item is with item parameters. \n
\nItem Values
| \n attributes \n | \n\n | \n | Frame attributes with data about the frame components and sizes. All height and width values are inches. | \n
| \n | profile_name | \n\n | Frame styles, example: Hanover, Derby. | \n
| \n | profile_material | \n\n | Frame material is either Metal or Wood. | \n
| \n | color_name | \n\n | Frame color, example: Gloss Gold. | \n
| \n | cover_name | \n\n | Frame cover material, example: Clear Acrylic. | \n
| \n | backing_name | \n\n | Frame backing material, Acid Free Foamcore. | \n
| \n | width | \n\n | Frame width, example: 8.5. | \n
| \n | height | \n\n | Frame height in inches with decimals example: 11. | \n
| \n | dimensions | \n\n | \n |
| \n | \n | width | \nFrame width, example: 8.5. | \n
| \n | \n | height | \nFrame height, example: 11. | \n
| \n | \n | depth | \nFrame depth, example: 2.25. | \n
| \n | profile_width | \n\n | Frame profile width, example: 2.25. | \n
| \n | outer_mat_type_name | \n\n | Matboard type, example: White Core. The outer matboad is the single matboard or top matboard. | \n
| \n | outer_mat_design_name | \n\n | Matboard type type, example: Smooth White. | \n
| \n | outer_mat_width | \n\n | The amount of visible matting, example: 1.5. | \n
| \n | outer_mat_opening_dimensions | \n\n | The matboard openning width and height. | \n
| \n | inner_mat_type_name | \n\n | Matboard type, example: White Core. The inner matboad is the second matboard or bottom matboard of the double-matboad. | \n
| \n | inner_mat_design_name | \n\n | Matboard type type, example: Smooth White. | \n
| \n | inner_mat_width | \n\n | The amount of visible matting, example: 0.5. | \n
| \n | inner_mat_opening_dimensions | \n\n | The matboard openning width and height. | \n
| \n | custom_print | \n\n | Frame has a print (boolean). | \n
| display_attributes | \n\n | \n | Frame attributes formatted to display to user | \n
| \n | Art Size | \n\n | The print size and also the inside dimension of the frame. | \n
| \n | Outside Frame Size | \n\n | Frame size outside dimension as it will fit on the wall. | \n
| \n | Style | \n\n | Frame profile and color names. | \n
| \n | Cover | \n\n | Frame cover name. | \n
| \n | Backing | \n\n | Frame backing name. | \n
| is_valid | \n\n | \n | Flag to indicate valid frame dataset could be built by paramerts (boolean). | \n
| name | \n\n | \n | The item name which is always 'Frame.' | \n
| price | \n\n | \n | The frame cost. | \n
| quantity | \n\n | \n | The quantity of items. | \n
| sku | \n\n | \n | Encoded numeric value representing the frame dataset. | \n
| shipping_estimate | \n\n | \n | Estimated value of shipping package based on frame dimensions and custom box. | \n
| \n | price | \n\n | Shipping estimate price. | \n
| \n | Calculated length + girth of package dimension. | \n\n | Shipping estimate price. | \n
| \n | shipping_template_group | \n\n | Tiered shipping price from 9.95 to 37.95. The shipping_estimate price rounded up to a practical shipping tier. | \n
| \n | shipping_method | \n\n | The shipping method id is the numeric ID for this shipping estimate. The numeric IDs can be 21 for USPS, 12 for UPS and 16 for FedEx. | \n
| pricing_group_id | \n\n | \n | Similarly priced frames can be grouped using this value too allow for bulk editing of frames with similar size and profile. | \n
Use the item parameters to retrieve the item dataset including frame cost. To retrieve a print only product item, include the item_type_name with the value 'print'.
\nThe paper values for prints can be photo, art or giclée value.
\n","urlObject":{"protocol":"https","path":["v1","items"],"host":["api.sandbox.frameiteasy.com"],"query":[],"variable":[]}},"response":[{"id":"477971f4-f437-4f24-972d-74d15332ef33","name":"Items (Params) Frame","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"sandbox@frameiteasy.com:0Az9*MtXQo"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":"{\n\t\"profile\": \"Derby\",\n\t\"color\": \"Black\",\n\t\"width\": 27.125,\n\t\"height\": 11.0625,\n\t\"outer_mat_type\": \"White Core\",\n\t\"outer_mat_color\": \"Smooth White\",\n\t\"outer_mat_thickness\": 1,\n\t\"inner_mat_type\": \"Black Core\",\n\t\"inner_mat_color\": \"Smooth Black\",\n\t\"inner_mat_thickness\": 1,\n\t\"cover\": \"Non-glare Acrylic\",\n\t\"image_url\":\"https://www.mywebsite.com/images/0evsgx6tbyhm5t5s7gf0.jpg\"\n}"},"url":"https://api.sandbox.frameiteasy.com/api/v1/items"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Orgin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1006"},{"key":"Date","value":"Tue, 28 Jul 2020 16:09:15 GMT"},{"key":"Server","value":"LiteSpeed"},{"key":"Vary","value":"User-Agent"}],"cookie":[],"responseTime":null,"body":"{\n \"attributes\": {\n \"profile_name\": \"Derby\",\n \"profile_material\": \"Wood\",\n \"color_name\": \"Black\",\n \"cover_name\": \"Non-Glare Acrylic\",\n \"backing_name\": \"Standard Foamcore\",\n \"width\": 27.125,\n \"height\": 11.0625,\n \"dimensions\": {\n \"width\": 27.125,\n \"height\": 11.0625,\n \"depth\": false\n },\n \"profile_width\": 1.25,\n \"outer_mat_type_name\": \"White Core\",\n \"outer_mat_design_name\": \"Smooth White\",\n \"outer_mat_width\": 1,\n \"outer_mat_opening_dimensions\": {\n \"width\": 28.625,\n \"height\": 12.5625,\n \"depth\": false\n },\n \"inner_mat_type_name\": \"Black Core\",\n \"inner_mat_design_name\": \"Smooth Black\",\n \"inner_mat_width\": 1,\n \"inner_mat_opening_dimensions\": {\n \"width\": 26.625,\n \"height\": 10.5625,\n \"depth\": false\n },\n \"custom_print\": 0\n },\n \"display_attributes\": {\n \"Art Size\": \"27 1/8\\\" x 11 1/16\\\"\",\n \"Outside Frame Size\": \"33 3/16\\\" x 17 1/8\\\"\",\n \"Style\": \"Derby, in Black\",\n \"Outer Mat\": \"1\\\" Smooth White (White Core)\",\n \"Inner Mat\": \"1\\\" Smooth Black (Black Core)\",\n \"Cover\": \"Non-Glare Acrylic\",\n \"Backing\": \"Standard Foamcore\"\n },\n \"is_valid\": true,\n \"name\": \"Frame\",\n \"price\": \"90.83\",\n \"quantity\": 1,\n \"sku\": \"26071205012721113200102020100\"\n}"},{"id":"48e346d7-c8e5-4b49-af23-ddc1612ac274","name":"Items (Params) Print Only","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"sandbox@frameiteasy.com:0Az9*MtXQo"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":"{\n \"item_type_name\": \"print\",\n \"paper\":\"photo\",\n \"backing\":\"none\",\n \"print_width\": 7.5,\n \"print_height\": 9.5,\n \"file_name\":\"0s7mm7w6nh7embgav4iy.jpg\"\n}\n"},"url":"https://api.sandbox.frameiteasy.com/api/v1/items"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Orgin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1006"},{"key":"Date","value":"Tue, 28 Jul 2020 16:09:15 GMT"},{"key":"Server","value":"LiteSpeed"},{"key":"Vary","value":"User-Agent"}],"cookie":[],"responseTime":null,"body":"{\n \"attributes\": {\n \"profile_name\": \"Derby\",\n \"profile_material\": \"Wood\",\n \"color_name\": \"Black\",\n \"cover_name\": \"Non-Glare Acrylic\",\n \"backing_name\": \"Standard Foamcore\",\n \"width\": 27.125,\n \"height\": 11.0625,\n \"dimensions\": {\n \"width\": 27.125,\n \"height\": 11.0625,\n \"depth\": false\n },\n \"profile_width\": 1.25,\n \"outer_mat_type_name\": \"White Core\",\n \"outer_mat_design_name\": \"Smooth White\",\n \"outer_mat_width\": 1,\n \"outer_mat_opening_dimensions\": {\n \"width\": 28.625,\n \"height\": 12.5625,\n \"depth\": false\n },\n \"inner_mat_type_name\": \"Black Core\",\n \"inner_mat_design_name\": \"Smooth Black\",\n \"inner_mat_width\": 1,\n \"inner_mat_opening_dimensions\": {\n \"width\": 26.625,\n \"height\": 10.5625,\n \"depth\": false\n },\n \"custom_print\": 0\n },\n \"display_attributes\": {\n \"Art Size\": \"27 1/8\\\" x 11 1/16\\\"\",\n \"Outside Frame Size\": \"33 3/16\\\" x 17 1/8\\\"\",\n \"Style\": \"Derby, in Black\",\n \"Outer Mat\": \"1\\\" Smooth White (White Core)\",\n \"Inner Mat\": \"1\\\" Smooth Black (Black Core)\",\n \"Cover\": \"Non-Glare Acrylic\",\n \"Backing\": \"Standard Foamcore\"\n },\n \"is_valid\": true,\n \"name\": \"Frame\",\n \"price\": \"90.83\",\n \"quantity\": 1,\n \"sku\": \"26071205012721113200102020100\"\n}"}],"_postman_id":"b1e6cb42-6671-4765-aa91-b842743da420"},{"name":"Shipping Methods","id":"49311ec9-7fae-459c-b2bc-6d6f38176b37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"sandbox@frameiteasy.com:0Az9*MtXQo","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"customer@uniquedesigns.com\",\n\t\"phone\": \"2031234567\",\n\t\"shipping_first_name\": \"Custom\",\n\t\"shipping_last_name\": \"Framer\",\n\t\"shipping_company\": \"Unique Designs\",\n\t\"shipping_address_1\": \"155 New Haven Ave\",\n\t\"shipping_address_2\": \"\",\n\t\"shipping_city\": \"Derby\",\n\t\"shipping_state\": \"CT\",\n\t\"shipping_zip\": \"06418\",\n\t\"items\": [{\n\t\t\t\"sku\": \"260102030240059F0000000000001\",\n\t\t\t\"quantity\": 1\n\t\t}\n\t]\n}"},"url":"https://api.sandbox.frameiteasy.com/v1/shipping-methods","description":"Get the shipping rate for several frame items.
\n","urlObject":{"protocol":"https","path":["v1","shipping-methods"],"host":["api.sandbox.frameiteasy.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"49311ec9-7fae-459c-b2bc-6d6f38176b37"},{"name":"Shipping","id":"83bf92a7-94fa-4ccc-a938-11833e867ccc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"sandbox@frameiteasy.com:0Az9*MtXQo","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"customer@uniquedesigns.com\",\n\t\"phone\": \"2031234567\",\n\t\"shipping_first_name\": \"Custom\",\n\t\"shipping_last_name\": \"Framer\",\n\t\"shipping_company\": \"Unique Design\",\n\t\"shipping_address_1\": \"155 New Haven Ave\",\n\t\"shipping_address_2\": \"\",\n\t\"shipping_city\": \"Derby\",\n\t\"shipping_state\": \"CT\",\n\t\"shipping_zip\": \"06418\",\n\t\"shipping_method\": 16,\n\t\"items\": [{\n\t\t\t\"sku\": \"26071203021802400000000000001\",\n\t\t\t\"quantity\": 2,\n\t\t\t\"image_url\": \"https://www.frameiteasy.com/uploads/frame-builder/0evsgx6tbyhm5t5s7gf0.jpg\"\n\t\t},\n\t\t{\n\t\t\t\"sku\": \"26071203021802400000000000001\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"image_url\": \"https://www.frameiteasy.com/uploads/frame-builder/0evsgx6tbyhm5t5s7gf0.jpg\"\n\t\t}\n\t]\n}"},"url":"https://api.sandbox.frameiteasy.com/v1/shipping","description":"Create order object for customer including shipping.
\n","urlObject":{"protocol":"https","path":["v1","shipping"],"host":["api.sandbox.frameiteasy.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"83bf92a7-94fa-4ccc-a938-11833e867ccc"},{"name":"Upload Image File","id":"59727b7e-e420-4132-857a-84a8aa4abec7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"sandbox@frameiteasy.com:0Az9*MtXQo"}],"body":{"mode":"formdata","formdata":[{"key":"image_file","type":"file","value":null}]},"url":"https://api.sandbox.frameiteasy.com/v1/upload_image","description":"Upload an image file in PNG or JPG format and at least 500x500 pixels in size. An image file named 'image_file' is required in the POST field.
\n
\nResponse Values
| file_name | \nThe filename of the image saved on the server. | \n
| thumbnail | \nURL of the image thumbnail. | \n
| width | \nImage pixel width. | \n
| height | \nImage pixel height. | \n
A GET user request will return user information.\nResponse Values
\n| first_name | \n
| last_name | \n
| user_name | \n
| shop | \n
| payment_description | \n
| payment_expiration_date | \n
| tax_exemption_certificates | \n
Find the frame sizes available by the pixel dimensions of an image.
\n
\nRequest Values
To generate a list of images sizes make a POST request to /image_sizes with these fields in the Json request.
\n| width | \nThe pixel width of the image file to be framed. | \n
| height | \nThe pixel height of the image file to be framed. | \n
\nResponse Values
| dpi | \nDots per inch, example 250. Provided in increments of 50 from 100 to 2400. | \n
| width_int | \nFrame width, example: 8. | \n
| width_dec | \nFrame width decimal, example: 0.5. | \n
| width_frac | \nFrame width fraction, example: 1/2. | \n
| height_int | \nFrame height, example: 11. | \n
| height_dec | \nFrame height decimal, example: 0.75. | \n
| height_frac | \nFrame height fraction, example: 3/4. | \n
| description | \nFull size description, example: 8 1/2\" x 11 3/4\" | \n
| wood | \nThe size will fit in a wood frame. Boolean. | \n
| metal | \nThe size will fit in a metal frame. Boolean. | \n
Save a custom frame size using the pixel dimensions of an image and the art size.
\nRequest Values
\nTo add a product to the system make a POST request to /products_user with the complete list of fields in the Json request. After successuflly saving size, the response will contain the full list of images sizes.
\n| action | \n\n | Use the value 'save' for adding the picture frame user_product to the system. | \n
| width | \n\n | The pixel width of the image file to be framed. | \n
| height | \n\n | The pixel height of the image file to be framed. | \n
| art_size | \n\n | \n |
| \n | width_int | \nArt size width, example: 8. | \n
| \n | width_dec | \nArt size width in decimals, example: 0.5. | \n
| \n | height_int | \nArt size height, example: 12. | \n
| \n | height_dec | \nArt size height in decimals, example: 0.25. | \n
Reset the custom values stored in the response from POST image_sizes.
\n| action | \nUse the value 'reset' for removing custom frame size values. | \n
To add an order to the system POST an API request to /order with the complete list of fields in the Json request. The order request will bill the API user's payment method stored in the system for then total order value. If the payment method is not available, an order will be created without a payment.
\n| \n | Customer email address. | \n|
| phone | \n\n | 9 digit phone number. | \n
| shipping_first_name | \n\n | Shipping first name. | \n
| shipping_last_name | \n\n | Shipping last name. | \n
| shipping_company | \n\n | Shipping company. | \n
| shipping_address_1 | \n\n | Shipping address 1. | \n
| shipping_address_2 | \n\n | Shipping address 2. | \n
| shipping_city | \n\n | Shipping city. | \n
| shipping_state | \n\n | Shipping state. (Use state abbreviation.) | \n
| shipping_zip | \n\n | Shipping zipcode. (5 digit zipcode value.) | \n
| shipping_country | \n\n | Shipping country. (2 letter country code.) | \n
| shipping_method_id | \n\n | Shipping method id uses numeric ID value from the API result /shipping-methods. The numeric IDs are 21 for USPS, 12 for UPS and 16 for FedEx. | \n
| billing_first_name | \n\n | Billing first name. | \n
| billing_last_name | \n\n | Billing last name. | \n
| billing_company | \n\n | Billing company. | \n
| billing_address_1 | \n\n | Billing address 1. | \n
| billing_address_2 | \n\n | Billing address 2. | \n
| billing_city | \n\n | Billing city. | \n
| billing_state | \n\n | Billing state. (Use state abbreviation.) | \n
| billing_zip | \n\n | Billing zipcode. (5 digit zipcode value.) | \n
| billing_country | \n\n | Billing country. (2 letter country abbreviation.) | \n
| items | \n\n | The items associated with the order using the sku from the API users product items. Items is an array of values to allow for multiple items per order. | \n
| \n | sku | \nCode representing the picture frame attributes. | \n
| \n | quantity | \nTotal number of items associate with the sku. | \n
| \n | filename | \nThe filename of the image used for this frame item, example twodaae0ushxc86afkvw.jpg. | \n
The order result contains the values below.
\nOrder Values
\n| billing_address | \n\n | \n | The order billing adddress. | \n
| \n | first_name | \n\n | Billing first name. | \n
| \n | first_name | \n\n | Billing last name. | \n
| \n | last_name | \n\n | Billing last name. | \n
| \n | company | \n\n | Billing company. | \n
| \n | address_1 | \n\n | Billing address 1. | \n
| \n | address_2 | \n\n | Billing address 2. | \n
| \n | city | \n\n | Billing city. | \n
| \n | state | \n\n | Billing state. | \n
| \n | zip | \n\n | Billing zipcode. | \n
| \n | country | \n\n | Billing country. | \n
| \n | is_commercial | \n\n | The billing address is a commercial address (boolean). | \n
| shipping_address | \n\n | \n | The shipping address of the customer receiving the product. | \n
| \n | first_name | \n\n | Shipping last name. | \n
| \n | last_name | \n\n | Shipping last name. | \n
| \n | company | \n\n | Shipping company. | \n
| \n | address_1 | \n\n | Shipping address 1. | \n
| \n | address_2 | \n\n | Shipping address 2. | \n
| \n | city | \n\n | Shipping city. | \n
| \n | state | \n\n | Shipping state. | \n
| \n | zip | \n\n | Shipping zipcode. | \n
| \n | country | \n\n | Shipping country. | \n
| \n | is_commercial | \n\n | The shipping address is a commercial address (boolean). | \n
| items | \n\n | \n | The items result values are the same as Item request in documentation above. | \n
| customer_status_name | \n\n | \n | The order status, Paid, In Transit, Shipped or Delivered. | \n
| date | \n\n | \n | The order unix time stamp. | \n
| \n | \n | Customer email. | \n|
| id | \n\n | \n | The order ID. | \n
| Phone | \n\n | \n | The customer phone. | \n
| Phone | \n\n | \n | The customer phone. | \n
| Totals | \n\n | \n | \n |
| \n | subtotal | \n\n | Order subtotal. | \n
| \n | shipping | \n\n | Order shipping fee. | \n
| \n | tax | \n\n | Order tax fee. | \n
| \n | total | \n\n | Order total. | \n
| \n | tracking_numbers | \n\n | Order tracking number after the order is shipped. | \n
Store owner products are saved to the API user's storage for editing and syncing to Shopify and other product selling systems.
\nSet the action value to save with the request to /user_products to save the products and variations. Use action value show_products to list all the store owner products and variations.
To retrieve a single product item use the unique product_id and action value of show_product_items. To delete a product use the action value of delete and the value product_id.
Request Values
\nTo add a product to the system make a POST request to /user_products with the complete list of fields in the Json request.
\naction | Use the value 'save' for adding the picture frame user_product to the system. | |||
name | The name of the product. Max length 100 characters. | |||
description | The description of the product. Max length 255 characters. | |||
file_name | Image file name from previously run POST /upload_image request. | |||
width | Image file width from the POST /upload_image request. | |||
height | Image file height from the POST /upload_image request. | |||
size_keys | Array of 6 character string values to create different sizes for frame products. size_keys values are available in the response from the POST /image_sizes. | |||
order_status_id | Set the order status ID for products. This value is used when a product is orderded to set to the order to either Paid or On Hold. Use the IDs of 1 for Paid or 15 for On Hold. (Defaults to Paid status) | |||
styles | Array of frame values that include the profile name and colors. Also includes the mats value. These values used in the Item attributes. | |||
profile | Object section of the styles that contains the params for the frame product. | |||
name | The name of the profile derived from the POST /Item values profile_name. | |||
colors | Array of colors for the profile. | |||
mats | Array of mats in the profile. (Optional) | |||
outer_mat_type | The mat_type_type derived from the POST /Item values mat_type_name. | |||
outer_mat_name | The mat_type_name derived from the POST /Item values mat_type_name. | |||
outer_mat_thickness | A numeric value with decimal indicating how much visible mat board (inches) to show on the front of the picture frame, example: 1.5. If the product requires multicple mat board thicknesses for different sizes, there is an option to use an array of values. For the array include size_key and outer_mat_thicknes, where the size_key corresponds with the user_products request size_key values. | |||
paper | The paper type for prints - either photo, art or giclée value. (Defaults to photo paper) | |||
filter | A variable to filter the response. Use the mat variants value to return only frames with matting in the response object. | |||
prints | Print values for defining the paper and backing type. | |||
paper | The paper type for prints - either photo, art or giclée value. (Defaults to photo paper) | |||
backing | The backing type for prints - either none or Acid Free Foamcore value. (Defaults to none) |
Response Values
\nproducts | |||
product_id | ID of the product. (Optional) | ||
name | Product name. | ||
description | Product description. | ||
file_name | The product file names, example: 99p6yiak0za7o5kfxyy7.jpg. | ||
image | The original image file URL. | ||
thumbnail | Product image thumbnail URL. | ||
image | URL to the original image. | ||
order_status_id | The product Order Status ID indicating if the product (after it is ordered) will be set as Paid or On Hold. | ||
item | |||
item_id | Product item ID, the different variations for the frame products. | ||
sku | Item SKU. | ||
preview | Product picture frame preview URL which shows the original image with the Frame Design with the SKU size proportions. | ||
item_price | Frame cost in dollars, example: 23.34. | ||
markup_price | Frame marketplace price, example: 28.34. |
Store owner products request to show when items are in stock or out of stock.
\n
\nResponse Values
| user_id | \n\n | \n | \n | The user_id of the account. | \n
| id | \n\n | \n | \n | The user product id. | \n
| item_id | \n\n | \n | \n | The user product item id. | \n
| sku | \n\n | \n | \n | The item sku. | \n
| in_stock | \n\n | \n | \n | Boolean indicating if product item is in stock. | \n
Store owner products request for product export, in most cases to generate a CSV to modify the markup_price.
\nResponse Values
\nproducts | product_id | The parent product item ID. | ||
items | The user product item ID (variant). | |||
name | Product name | |||
size | Frame size | |||
style | Frame style | |||
color | Frame color | |||
variant_id | The variant ID from Shopify. | |||
sku | The Frame It Easy item SKU. | |||
item_price | The frame price. | |||
markup_price | Store seller price with markup. | |||
shipping_estimate | Estimated value of shipping package based on frame dimensions and custom box. | |||
profit_estimate | Estimated profit using the markup_price and the item_price plus shipping_estimate. |
Store owner products endpoint request for product import to update the markup_price.
\nUpload a CSV file using this endpoint. The file must be in CSV format with the columns product_id, item_id and markup_price. For the endpoint request, a file named 'csv_file' is required in the POST field.
\n
\nResponse Values
| error | \nA message indicating why the CSV import failed. | \n
| success | \nA message idicating the total number of product items updated. | \n
Store owner products can be updated with information.
\nSet the action value to update_product with the request to /products_user to update the parent product values. \nUse action value update_product_item to update the variations.
\n
\nProduct Values
| product_id | \n\n | \n | Cannot be changed, used for selecting the product to update. (required) | \n
| name | \n\n | \n | Product name. | \n
| description | \n\n | \n | Product description. | \n
| inventory_item_id | \n\n | \n | A remote system inventory_id for syncing, used in Shopify. | \n
Product Items (Variants) Values
\n| product_id | \n\n | \n | Cannot be changed, used for selecting the product to update. (required) | \n
| item_id | \n\n | \n | Cannot be changed, used for selecting the product to update. (required) | \n
| markup_price | \n\n | \n | Store seller price with markup. | \n
Get all order data stored for this user account sorted by Order date ascending. For more than 10 orders, use the pages data.
\n
\nOrder pages values
| total_count | \nTotal number of orders. | \n
| page_number | \nCurrent page. | \n
| page_row_limit | \nThe number of orders per page. | \n
| previous_page | \nThe previous orders /orders?page=1. | \n
| next_page | \nThe next orders /orders?page=3. | \n
| last_page | \nThe last orders /orders?page=3. | \n
Put completed order into database.
\n","urlObject":{"protocol":"https","path":["v1","orders"],"host":["api.sandbox.frameiteasy.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1eb0b87d-5dcc-4961-8b5f-3102f1820a12"},{"name":"Orders (ID)","id":"850adef1-85ab-47c8-a207-091c22790afc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"sandbox@frameiteasy.com:0Az9*MtXQo"}],"body":{"mode":"raw","raw":""},"url":"https://api.sandbox.frameiteasy.com/v1/orders/502434","urlObject":{"protocol":"https","path":["v1","orders","502434"],"host":["api.sandbox.frameiteasy.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"850adef1-85ab-47c8-a207-091c22790afc"},{"name":"Access Token","id":"0953d5dd-daea-4463-acff-18a6f5eb1223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"sandbox@frameiteasy.com:0Az9*MtXQo"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.sandbox.frameiteasy.com/v1/access_token","description":"Access Token
\nResponse from access token request for front-end requests. Use the access token in the Authorization header.
\nAccess token values
\naccess_token | A token with a short life span. |
To access the image file without a frame preview, use POST /image_urls. The response will contain URL values for the full size, medium and thumbnail image files.
\n
\nRequest Value
| product_id | \n\n | \n | \n | Use the product_id from the POST /user_products endpoint. | \n
\nResponse Values
| image | \n\n | \n | \n | URL of the full size image. | \n
| medium | \n\n | \n | \n | URL of the medium image. | \n
| thumbnail | \n\n | \n | \n | URL of the thumnail image. | \n