{"info":{"_postman_id":"49d38987-2cd2-4e5a-88b7-c9289947628d","name":"Blanka API (Beta)","description":"

This is the instructions for integrating a 3rd party app to Blanka using Blanka's API (Beta)

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10905449","collectionId":"49d38987-2cd2-4e5a-88b7-c9289947628d","publishedId":"2sA35LWzqV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"246071","highlight":"d56f5b"},"publishDate":"2024-04-10T20:28:37.000Z"},"item":[{"name":"Get Products","id":"0e9ddc5e-01ae-4fb5-a507-2a186c5e5681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.blankabrand.com/api/v1/products/","description":"

API key

Please contact Blanka to recieve your API key.

Pagination Parameters

page: Specifies the page number of the dataset to retrieve. The first page is 1. If omitted, the first page is returned by default.
\n
page_size: (Optional) Determines the number of items per page. The API has default and maximum values set for this parameter. This parameter can be used to override the default page size.
\n

Filtering Parameters

\n","urlObject":{"protocol":"https","path":["api","v1","products",""],"host":["api","blankabrand","com"],"query":[],"variable":[]}},"response":[{"id":"57099e90-3fb3-4e3b-82fb-a6577ca6736b","name":"Get Products","originalRequest":{"method":"GET","header":[],"url":"https://api.blankabrand.com/api/v1/products/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 450,\n \"next\": \"http://api.blankabrand.com/api/v1/products/?page=2\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": 209567,\n \"name\": \"Reusable Bamboo Cotton Rounds\",\n \"sku\": \"BLNK-AB-04-02-CTP\",\n \"branded_box_available\": false,\n \"available_inventory\": -1,\n \"suggested_cost\": \"18.00\",\n \"cost\": \"9.63\",\n \"weight\": 72,\n \"color_code\": \"\",\n \"color_name\": \"\",\n \"product_type\": \"BLANK\",\n \"image\": \"https://images.blankabrand.com/unbranded/BLNK-AB-04-02-CTP.webp?v=870632\",\n \"categories\": [\n \"eyes\",\n \"face\",\n \"skincare\",\n \"cleanse\",\n \"organic\",\n \"accessories\",\n \"cotton-rounds\",\n \"tools\",\n \"product-benefit\",\n \"travel-friendly\",\n \"makeup-removers\"\n ],\n \"is_expiring\": false,\n \"description\": \"

Move over disposable cotton rounds and make way for these Reusable Bamboo Cotton Rounds! Washable, reusable, and biodegradable, these rounded pads are perfect for removing makeup and are suitable for any skin type. Our 12-pack of organic cotton pads are built with 3 soft and natural, anti-pilling layers for a clean wash every time.

\",\n \"product_notes\": null,\n \"benefits\": \"

3 soft, organic layers of bamboo cotton for sensitive facial areas
Biodegradable, organic bamboo cotton softens the skin
Anti-pilling technology helps reusable cotton pads last longer
Comes in a pack of 12

\",\n \"application\": \"

Use on your face, neck, and eyes with your usual makeup remover or cleanser
After use, wash by hand in warm water then dry the cotton pads in open air before using again

\",\n \"ingredients\": \"

Bamboo cotton

\",\n \"expires_at\": null,\n \"product_base\": null\n },\n {\n \"id\": 209570,\n \"name\": \"Natural Konjac Sponge\",\n \"sku\": \"BLNK-AB-04-02-KJS\",\n \"branded_box_available\": false,\n \"available_inventory\": -3,\n \"suggested_cost\": \"16.00\",\n \"cost\": \"4.28\",\n \"weight\": 32,\n \"color_code\": \"\",\n \"color_name\": \"\",\n \"product_type\": \"BLANK\",\n \"image\": \"https://images.blankabrand.com/unbranded/BLNK-AB-04-02-KJS.webp?v=181459\",\n \"categories\": [\n \"face\",\n \"skincare\",\n \"all-natural\",\n \"accessories\",\n \"konjac-sponge\",\n \"tools\",\n \"product-benefit\",\n \"travel-friendly\",\n \"sponges\"\n ],\n \"is_expiring\": false,\n \"description\": \"

A natural, plant fiber Konjac Sponge for a better exfoliating face scrub. This rounded sponge fits perfectly in the palm of your hand for your daily facial routine. Use it with your favorite cleanser to remove all impurities! Made from konjac root fibers, this sponge is biodegradable and all natural. The Konjac Sponge is the perfect solution for cleaner, smoother skin!

\",\n \"product_notes\": null,\n \"benefits\": \"

All-natural sponge that’s clean for your skin and clean for the Earth
Excellent exfoliant for smoother skin
Composed of biodegradable, compostable plant fibers
Suitable for all skin types

\",\n \"application\": \"

Wet the konjac sponge with warm water until it softens
Massage the skin with circular motions
Rinse the sponge and hang it with the string to let it dry between uses
After 2-3 months of use (or 100 uses), put the konjac sponge in the compost.

\",\n \"ingredients\": \"

Konjac Root Fibers

\",\n \"expires_at\": null,\n \"product_base\": null\n }\n ]\n}"}],"_postman_id":"0e9ddc5e-01ae-4fb5-a507-2a186c5e5681"},{"name":"Create Order","id":"1b39c966-dbc3-427b-a0d5-9f9693772258","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"475632\",\n \"shipping_address\": {\n \"address_1\": \"16 rodeo drive\",\n \"address_2\": \"9\",\n \"city\": \"Los Angles\",\n \"company\": \"Acme Inc\",\n \"country\": \"US\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"postcode\": \"90210\",\n \"state\": \"California\",\n \"phone\": \"324323\"\n },\n \"line_items\": [\n {\n \"sku\": \"BLNK-AB-04-02-RO-QZ1\",\n \"quantity\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blankabrand.com/api/v1/orders/","description":"

Creates a new order in our system. The order if succesfull will appear in the orders section of the dashboard https://app.blankabrand.com/orders/customer-orders

Test Mode

To test the order creation endpoint add the query parameter:

https://api.blankabrand.com/api/v1/orders/?test=true\n\n

\n","urlObject":{"protocol":"https","path":["api","v1","orders",""],"host":["api","blankabrand","com"],"query":[],"variable":[]}},"response":[{"id":"612d32e8-1da4-4133-a1d5-1b3c73299a6e","name":"Create Order","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"475632\",\n \"shipping_address\": {\n \"address_1\": \"16 rodeo drive\",\n \"address_2\": \"9\",\n \"city\": \"Los Angles\",\n \"company\": \"Acme Inc\",\n \"country\": \"US\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"postcode\": \"90210\",\n \"state\": \"California\",\n \"phone\": \"324323\"\n },\n \"line_items\": [\n {\n \"sku\": \"BLNK-AB-04-02-RO-QZ1\",\n \"quantity\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blankabrand.com/api/v1/orders/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Apr 2024 22:26:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"362"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Accept-Language, Origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8799841018d161f5-YVR"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"337539\",\n \"order_id\": \"475632\",\n \"status\": \"PAYMENT_REQUIRED\",\n \"tracking_code\": null,\n \"line_items\": [\n {\n \"sku\": \"BLNK-AB-04-02-RO-QZ1\",\n \"quantity\": 2\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"16 rodeo drive\",\n \"address_2\": \"9\",\n \"city\": \"Los Angles\",\n \"company\": \"Acme Inc\",\n \"country\": \"US\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"postcode\": \"90210\",\n \"state\": \"California\",\n \"phone\": \"324323\"\n }\n}"}],"_postman_id":"1b39c966-dbc3-427b-a0d5-9f9693772258"},{"name":"Webhook - update order status","id":"dbdf6f0c-e7bf-4abc-b0b7-74a7ea2e144c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"123\",\n \"tracking_code\": \"123\",\n \"status\": \"SHIPPED\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://{webhook_destination}","description":"

This webhook will fire when an order is shipped. Please provide us with a webhook endpoint to send the POST to.

\n","urlObject":{"protocol":"https","host":["{webhook_destination}"],"query":[],"variable":[]}},"response":[{"id":"5ee29746-8839-4456-80ee-7b6ff68697bc","name":"Webhook - update order status","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"123\",\n \"tracking_code\": \"123\",\n \"status\": \"SHIPPED\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://{webhook_destination}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"order_id\": \"123\",\n \"tracking_code\": \"123\",\n \"status\": \"SHIPPED\"\n}"}],"_postman_id":"dbdf6f0c-e7bf-4abc-b0b7-74a7ea2e144c"}]}