{"_id":"5436a1e1d0ffee0e00f18f92","__v":22,"is_link":false,"user":"5436a1afb7cf0e1c0020d9ca","category":{"_id":"5436a1e1d0ffee0e00f18f90","version":"5436a1e1d0ffee0e00f18f8f","project":"5436a1e1d0ffee0e00f18f8c","__v":4,"pages":["5436a1e1d0ffee0e00f18f92","5436aa99b7cf0e1c0020da44","5436aae8d0ffee0e00f18ff8","5436aab7b7cf0e1c0020da46"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-09T14:55:29.547Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"project":"5436a1e1d0ffee0e00f18f8c","version":{"_id":"5436a1e1d0ffee0e00f18f8f","project":"5436a1e1d0ffee0e00f18f8c","__v":12,"createdAt":"2014-10-09T14:55:29.536Z","releaseDate":"2014-10-09T14:55:29.536Z","categories":["5436a1e1d0ffee0e00f18f90","5436aa49d0ffee0e00f18ff1","5436aa50d0ffee0e00f18ff2","5436aa57b7cf0e1c0020da41","543979262e0fd70e00ec643a","54495081cdc9442200488577","54495092cdc9442200488579","544950ff3acc37080099e74f","544ea1a4cf9f860800800c8c","544ea1c9cf9f860800800c8d","54524a9604160008005b1cf2","5453c1e008d1800800473e4a"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-09T14:55:29.575Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"try":true,"basic_auth":false,"results":{"codes":[]},"auth":"never","params":[],"url":""},"isReference":false,"order":0,"body":"Thank you for using the ShippingEasy APIs.  We have different APIs for different audiences.  Please take a moment to read this overview before getting started. \n\n**This is an early draft of our new documentation site.  You may find errors and / or missing references.  We are working diligently to get the site updated and finished.  We thank you for your patience.**\n\n##Customer API\n\nThe customer API allows customers and partners to exchange information with the ShippingEasy system.  This includes searching existing orders or creating new orders in a ShippingEasy account.  \n\nIf you are working on developing an integration between ShippingEasy and a 3rd party e-commerce platform, the customer API provide all the resources you need to implement your integration. \n\n##Partner API\n\nThe partner APIs are for obtaining shipping rate quotes and for creating ShippingEasy customer accounts. \n\nThe Rate Quoting API allows partners to obtain accurate, real-time quotes for all major shipping carriers. \n\nThe Account Provisioning API allows a partner to streamline the ShippingEasy account creation process for customers that the partner refers to ShippingEasy.\n\n##EasyShip Widget\n\nEasyShip is for partners who want to add a simple shipping widget to an ecommerce platform back-office environment. It allows merchants to seamlessly generate shipping labels in order to fulfill ecommerce orders. The supported workflow is:\n\n  * Merchant clicks the EasyShip button within the partner's ecommerce platform. \n  * Modal window opens pre-populated with order details including \"ship to\" and \"ship from\" addresses and product weight\n  * Merchant reviews and edits details as needed\n  * Merchant reviews rate quotes from the available shipment services\n  * Merchant purchases a shipping label - EasyShip generates the shipment label and delivers it via email.","excerpt":"","slug":"getting-started","type":"basic","title":"Getting Started"}
Thank you for using the ShippingEasy APIs. We have different APIs for different audiences. Please take a moment to read this overview before getting started. **This is an early draft of our new documentation site. You may find errors and / or missing references. We are working diligently to get the site updated and finished. We thank you for your patience.** ##Customer API The customer API allows customers and partners to exchange information with the ShippingEasy system. This includes searching existing orders or creating new orders in a ShippingEasy account. If you are working on developing an integration between ShippingEasy and a 3rd party e-commerce platform, the customer API provide all the resources you need to implement your integration. ##Partner API The partner APIs are for obtaining shipping rate quotes and for creating ShippingEasy customer accounts. The Rate Quoting API allows partners to obtain accurate, real-time quotes for all major shipping carriers. The Account Provisioning API allows a partner to streamline the ShippingEasy account creation process for customers that the partner refers to ShippingEasy. ##EasyShip Widget EasyShip is for partners who want to add a simple shipping widget to an ecommerce platform back-office environment. It allows merchants to seamlessly generate shipping labels in order to fulfill ecommerce orders. The supported workflow is: * Merchant clicks the EasyShip button within the partner's ecommerce platform. * Modal window opens pre-populated with order details including "ship to" and "ship from" addresses and product weight * Merchant reviews and edits details as needed * Merchant reviews rate quotes from the available shipment services * Merchant purchases a shipping label - EasyShip generates the shipment label and delivers it via email.