{"workspace":{"id":52336,"name":"Shiip","description":null,"slug":"ideraos","theme":null,"createdAt":"2021-07-28T16:01:50.843963+00:00","updatedAt":"2022-10-05T02:47:24.394625+00:00","logoUrl":"https://app.goshiip.com/icon.png","faviconUrl":null,"domain":"developer.goshiip.com","homeContent":"\n\n# 👋 Welcome to Shiip Developer Documentation\n\nUse Ship APIs to customize your shipping experience. Shiip allows you to find, compare, select and buy courier services for local, national and international shipping services.\n\nShiip has an easy-to-use, customizable API that you can depend on to offer shipping to partners, merchants, customers and more.\n\nWith our single integration, you’ll get everything from labels and manifests to tracking and returns. We standardize carrier processes and streamline the complexities of shipping, so you can offer a best-in-class solution without the upkeep.\n\n#### Shiip’s API is used across business use cases, including:\n\n\n\n\n- Logistics Providers\n- E-commerce Platforms\n- Marketplaces\n- Direct Retailers\n\nWe have a quick and easy set up process, so you can create your first shipment in no time!\n\nCheck our [Platform](https://app.goshiip.com) and Dig into our [documentation](/docs/shiip) to plug our ready-made APIs into your businesses.\n\n---\n\n![get-started-icon](https://img.icons8.com/cotton/128/000000/launch-rocket.png)\n\n## Using Shiip's API\n\n\n\n> 💡 There are a few key differences between the Web App and our API integration.\n\n### Web App\nWith our Web App, you can easily set up an account (usually in 2 minutes or less) and instantly start shipping with for DHL, FEDEx, UPS, UPSP, Gokada, Kwik, GIG and more.\nYou can also connect with more carriers, integrate with E-commerce platforms, and customize the experience for your business.\n\n### API\nDevelopers can easily use the powerful Shiip API to customize and automate shipping processes to meet your business’ needs.\nShiip lets you integrate with multiple carriers through one API, and it’s easy to implement with step-by-step sample code, pre-built client libraries, and test keys.\n\n### What's the difference?\n1. With the API, you can build your own shipping experience!\n2. Our API tends to be more customizable and can provide a highly-automated shipping experience.\n3. For lots of shippers, the API gives users more flexibility to ship higher quantities. Most of our high volume customers use our API to create labels because it gives them the freedom to create more than 100 in batches.\n4. In addition, the API gives customers the ability to add more features like third-party billing, multi-piece shipments, Cash on Delivery, and a few others.\n\n## Get Started\n\n\n\n> 💡 Here are steps to get started\n\n### Open An Account\n\nOpen a Shiip Account on [Shiip](https://app.goshiip.com) and contact our Team at [sales@goshiip.com](mailto:sales@goshiip.com) for information about our services.\n\n\n\n### Download our brand assets\n\nGet our full brand assets kit, including logos, symbols that tells our story as a brand and company.\n\n[Download Logo Assets](https://drive.google.com/drive/folders/1NiK0_qyYBSDLiBxFubLMx1EyFFo0R9nz?usp=sharing)\n\n\n\n### Explore our APIs\n\nExplore our beautiful written APIs Documentation and start integrating into your platforms.\n\n\n![faqs-icon](https://img.icons8.com/cotton/64/000000/scroll--v1.png)\n\n## Webhooks\nLearn how to listen to events whenever certain actions occur on your integration.\n\n### What are webhooks?\n\nWhenever shipment status changes on your Shiip integration, we trigger events which your application can listen to. This is where webhooks come in. A webhook is a URL on your server where we send payloads for such events. For example, if you implement webhooks, once a shipment status changes from pending to assigned, we will immediately notify your server.\n\n**You can specify your webhook URL by sending a mail to our Support Team (hello@goshiip.com) where we would send POST requests to whenever an event occurs.**\n\n\n\n## FAQs\n\n\n\n> 💡 Have any questions?\n>\n> You can check out FAQs here [FAQs](https://goshiip.com/faqs)\n\n\n## We're Here to Help\n\n\n\n> 💡 We are always here to help you 24/7, You can contact our Support Page\n>\n>\n\nGet in touch and let us know how we can help.\n\n[Support Page](https://goshiip.com/support)
\nChat with us on the Chatbox on our Platform and Homepage
\nAnd contact our Support Team at[sales@goshiip.com](mailto:sales@goshiip.com) \n\n\n\n\n\n\n> Contact sales at [sales@goshiip.com](mailto:sales@goshiip.com) to get help from our team of in-house experts.\n\n\n\n\n\n> Built with ❤️ by [Shiip Team](https://goshiip.com).","hidePoweredBy":false,"localizejs":null,"hideSignIn":false,"googleTagManager":null,"redirects":null,"creatorId":86477,"migratedFromNext":false,"features":[{"id":320575,"maxQuantity":30,"feature":{"id":1,"name":"changelogs","type":"limit","__typename":"sl_features"},"__typename":"sl_workspace_features"},{"id":320576,"maxQuantity":null,"feature":{"id":2,"name":"custom_domain","type":"toggle","__typename":"sl_features"},"__typename":"sl_workspace_features"},{"id":320577,"maxQuantity":3,"feature":{"id":3,"name":"members","type":"limit","__typename":"sl_features"},"__typename":"sl_workspace_features"},{"id":320578,"maxQuantity":1000,"feature":{"id":4,"name":"hosted_mocking","type":"limit","__typename":"sl_features"},"__typename":"sl_workspace_features"},{"id":320579,"maxQuantity":2,"feature":{"id":5,"name":"projects","type":"limit","__typename":"sl_features"},"__typename":"sl_workspace_features"},{"id":765585,"maxQuantity":null,"feature":{"id":31,"name":"show_referral_banner","type":"toggle","__typename":"sl_features"},"__typename":"sl_workspace_features"}],"integrations":[{"id":194044,"name":"Bitbucket Cloud","enabled":true,"config":{},"allowUserLogin":true,"allowUserRegister":true,"integration":{"id":9,"kind":"bitbucket_cloud","shortcode":"bbc","name":"Bitbucket Cloud","config":{"apiUrl":"https://api.bitbucket.org/2.0","hostUrl":"https://bitbucket.org","clientId":"FJt5Jb9DwW8K4YWGfE","redirectUrl":"https://stoplight.io:443/oauth/callback"},"__typename":"sl_integrations"},"__typename":"sl_workspace_integrations"},{"id":194041,"name":"Email","enabled":true,"config":{},"allowUserLogin":true,"allowUserRegister":true,"integration":{"id":1,"kind":"builtin","shortcode":"sl","name":"Email","config":{},"__typename":"sl_integrations"},"__typename":"sl_workspace_integrations"},{"id":194042,"name":"GitHub","enabled":true,"config":{},"allowUserLogin":true,"allowUserRegister":true,"integration":{"id":2,"kind":"github","shortcode":"gh","name":"GitHub","config":{"apiUrl":"https://api.github.com","hostUrl":"https://github.com","clientId":"14b4eb468fc1419a5290","redirectUrl":"https://stoplight.io:443/oauth/callback"},"__typename":"sl_integrations"},"__typename":"sl_workspace_integrations"},{"id":194043,"name":"GitLab","enabled":true,"config":{},"allowUserLogin":true,"allowUserRegister":true,"integration":{"id":3,"kind":"gitlab","shortcode":"gl","name":"GitLab","config":{"apiUrl":"https://gitlab.com/api/v4","hostUrl":"https://gitlab.com","clientId":"ac92ea2ad339f25ae1f3264c2d851c8eb23f84e8ea5ec297d3504dc735488238","redirectUrl":"https://stoplight.io:443/oauth/callback"},"__typename":"sl_integrations"},"__typename":"sl_workspace_integrations"}],"disableDefaultStyleguideEditing":false,"joinRequestsDisabled":false,"guestsReceiveDailyDigest":true,"showTryit":true,"showTryitMockServer":true,"__typename":"sl_workspaces"}}