{"info":{"_postman_id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","name":"ShipBlink API (EasyPost)","description":"<html><head></head><body><h1 id=\"integrating-with-shipblink\">🚀 Integrating with ShipBlink</h1>\n<p>ShipBlink strives to streamline shipping for online sellers, no matter where they sell their products online. We are continuously adding new marketplaces, shopping carts, and integration tools, because we know the e-commerce space is growing.</p>\n<h1 id=\"shipblink-api\">🔌 ShipBlink API</h1>\n<p>The API is a great way to get data directly to and from ShipBlink, like creating orders, updating products, and querying order, shipment and customer data.</p>\n<p>Our API is available for any plan and allows developers to build applications that interface with the ShipBlink &amp; EasyPost platform. The API can be used to automate many tasks including:</p>\n<ul>\n<li><p>Managing Orders</p>\n</li>\n<li><p>Managing Shipments</p>\n</li>\n<li><p>Creating Shipping Labels</p>\n</li>\n<li><p>Retrieving Shipping Rates</p>\n</li>\n</ul>\n<h2 id=\"💻-custom-storeomswms-integration\">💻 Custom Store/OMS/WMS Integration</h2>\n<p>ShipBlink also allows you to directly integrate your company's online store directly into ShipBlink by building an integration with ShipBlink's APIs.</p>\n<p>The method that's right for your integration very much depends on the type of integration you're planning on implementing. A Custom Order allows ShipBlink to <em>pull</em> order information from your platform the very same way we <em>pull</em> data from marketplaces such as eBay, WooCommerce, and Shopify.</p>\n<p>Once an order has been shipped in ShipBlink, ShipBlink automatically <em>pushes</em> tracking information back to your custom store. Alternatively, your system can <em>pull</em> Order Shipments via APIs as well.</p>\n<h2 id=\"🔐-authentication\">🔐 Authentication</h2>\n<p>ShipBlink APIs use Token Authentication and currently in private Beta. Please request access at <a href=\"mailto:support@shipblink.com\">support@shipblink.com</a></p>\n<h2 id=\"😀-support\">😀 Support</h2>\n<p>File a ticket at <a href=\"https://mailto:support@shipblink.com\">support@shipblink.com</a> and we'll get back ASAP!</p>\n<h3 id=\"💪-pro-tips\">💪 Pro tips</h3>\n<ul>\n<li>Configure Dimension Units &amp; Weight Units in <a href=\"https://app.shipblink.com/settings\">ShipBlink Settings</a></li>\n</ul>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"🚀 Integrating with ShipBlink","slug":"integrating-with-shipblink"},{"content":"🔌 ShipBlink API","slug":"shipblink-api"}],"owner":"35580732","collectionId":"3b535b4b-5c24-42af-b8b1-261c49eda15a","publishedId":"2sA3QwbVUL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-06-01T22:36:10.000Z"},"item":[{"name":"Get All Orders","event":[{"listen":"test","script":{"id":"19845252-682a-4d50-a30b-e592e1a8245a","exec":["pm.test(\"Status code is 200\", function () {","    pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"5314d94b-d7bb-4a72-990e-f9e017dd382d","request":{"method":"GET","header":[],"url":"https://api.shipblink.com/public/custom_orders/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","name":"ShipBlink API (EasyPost)","type":"collection"}},"urlObject":{"path":["public","custom_orders",""],"host":["https://api.shipblink.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5314d94b-d7bb-4a72-990e-f9e017dd382d"},{"name":"Get Orders by ID","event":[{"listen":"test","script":{"id":"f424068e-2020-470e-b0b1-9fca920d5419","exec":["pm.test(\"Status code is 200\", function () {","    pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"680b34b2-4256-4e47-b342-c4afdaec48e0","request":{"method":"GET","header":[],"url":"https://api.shipblink.com/public/custom_orders/:order_id/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","name":"ShipBlink API (EasyPost)","type":"collection"}},"urlObject":{"path":["public","custom_orders",":order_id",""],"host":["https://api.shipblink.com"],"query":[],"variable":[{"type":"any","value":"","key":"order_id"}]}},"response":[],"_postman_id":"680b34b2-4256-4e47-b342-c4afdaec48e0"},{"name":"Create Order","event":[{"listen":"test","script":{"id":"81c69c18-4fb0-4fc3-82fe-c2dd774f1a44","exec":["pm.test(\"Successful POST request\", function () {","    pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});",""],"type":"text/javascript","packages":{}}}],"id":"a23cf66a-9e7c-4d95-9b68-8bcb202e669c","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"platform_order_id\": \"#1105\",\n    \"order_variants\": [\n        {\n            \"platform_variant_id\": \"4869546108\",\n            \"product_name\": \"10inch Anime Cute Digital Monster Digimon Koromon Soft Plush Toy Doll Pillow\",\n            \"variant_name\": \"variant_name - 10inch Anime Cute Digital Monster Digimon Koromon Soft Plush Toy Doll Pillow\",\n            \"variant_sku\": \"TOY136\",\n            \"variant_weight\": \"0.00\",\n            \"variant_height\": \"0.00\",\n            \"variant_length\": \"0.00\",\n            \"variant_width\": \"4.00\",\n            \"base_price\": \"9.99\",\n            \"item_discount\": \"0.00\",\n            \"quantity\": 5,\n            \"quantity_shipped\": 0,\n            \"image_url\": \"https://cdn.shopify.com/s/files/1/0572/4255/0430/products/db3fd016e2307b39865de8a25d9dac03.jpg?v=1646633518\"\n        }\n    ],\n    \"platform_customer_id\": \"6333631\",\n    \"created_at\": \"2024-04-30T15:20:09Z\",\n    \"updated_at\": \"2024-04-30T15:20:10Z\",\n    \"status\": \"paid\",\n    \"total_shipping_cost\": \"0.00\",\n    \"total_handling_cost\": \"0.00\",\n    \"total_tax_cost\": \"0.00\",\n    \"total_order_cost\": \"49.95\",\n    \"total_discount\": \"0.00\",\n    \"total_no_items\": 5,\n    \"total_no_shipped_items\": null,\n    \"payment_method\": \"manual\",\n    \"payment_status\": \"paid\",\n    \"refunded_amount\": null,\n    \"currency_code\": \"USD\",\n    \"staff_notes\": null,\n    \"customer_message\": null,\n    \"shipping_address\": {\n        \"zip\": \"73099\",\n        \"city\": \"Yukon\",\n        \"email\": \"friends@shipblink.com\",\n        \"phone\": null,\n        \"state\": \"Oklahoma\",\n        \"company\": \"EP\",\n        \"country\": \"United States\",\n        \"street_1\": \"123 West Main Street\",\n        \"street_2\": null,\n        \"last_name\": \"Test\",\n        \"first_name\": \"Josh\",\n        \"country_iso2\": \"US\",\n        \"shipping_method\": null\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.shipblink.com/public/custom_orders/","description":"<p>Create Order API</p>\n<p><code>Order.platform_order_id</code> is unique per ShipBlink Store and <code>OrderVariant.platform_variant_id</code> is unique per Order.</p>\n<p>These attributes can be used as a reference between your own system and ShipBlink, maintaining uniqueness and avoiding duplicate data.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","name":"ShipBlink API (EasyPost)","type":"collection"}},"urlObject":{"path":["public","custom_orders",""],"host":["https://api.shipblink.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a23cf66a-9e7c-4d95-9b68-8bcb202e669c"},{"name":"Update Order by ID","event":[{"listen":"test","script":{"id":"c23e6e13-5804-460e-88e9-91b77e203769","exec":["pm.test(\"Successful PUT request\", function () {","    pm.expect(pm.response.code).to.be.oneOf([200, 201, 204]);","});",""],"type":"text/javascript","packages":{}}}],"id":"d25b66a6-b3da-42aa-add5-86766c6499bf","request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\t\"payment_status\": \"voided\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.shipblink.com/public/custom_orders/:order_id/","description":"<p>Update specific attributes of an Order</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","name":"ShipBlink API (EasyPost)","type":"collection"}},"urlObject":{"path":["public","custom_orders",":order_id",""],"host":["https://api.shipblink.com"],"query":[],"variable":[{"type":"any","value":"","key":"order_id"}]}},"response":[],"_postman_id":"d25b66a6-b3da-42aa-add5-86766c6499bf"},{"name":"Archive Order","event":[{"listen":"test","script":{"id":"294f94fb-67ed-45ed-90c5-c3a922da6ad7","exec":["pm.test(\"Successful DELETE request\", function () {","    pm.expect(pm.response.code).to.be.oneOf([200, 202, 204]);","});",""],"type":"text/javascript","packages":{}}}],"id":"e0a07a9b-205d-4aee-89c9-4c9a2b9594c1","request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.shipblink.com/public/custom_orders/:order_id/","description":"<p>Please reach out to <a href=\"mailto:support@shipblink.com\">support@shipblink.com</a> if you'd like to access this endpoint.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","id":"3b535b4b-5c24-42af-b8b1-261c49eda15a","name":"ShipBlink API (EasyPost)","type":"collection"}},"urlObject":{"path":["public","custom_orders",":order_id",""],"host":["https://api.shipblink.com"],"query":[],"variable":[{"type":"any","value":"","key":"order_id"}]}},"response":[],"_postman_id":"e0a07a9b-205d-4aee-89c9-4c9a2b9594c1"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"dcc1caf6-22a1-4590-be71-6e6f263e365a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"71248503-1c40-4ca3-a89a-d7160f5e1acd","type":"text/javascript","exec":[""]}}],"variable":[{"key":"api_key","value":"","type":"string"},{"key":"base_url","value":"https://api.shipblink.com"}]}