{"version":1,"pages":[{"id":"-MPiyR5Vl_IStNOIkWwT","title":"Overview","pathname":"/","siteSpaceId":"sitesp_qCa19","description":"Shiplemon provides an API to programmatically get parcel rates, create shipments and automate the process of sending packages"},{"id":"-MPizM-PNvORqm50i-Ld","title":"Authentication","pathname":"/untitled","siteSpaceId":"sitesp_qCa19","description":"In order to use the API of Shiplemon.com, you should contact us in order to create an API key for you. Start by sending an email at info@shiplemon.com"},{"id":"-MPj-j5favyMdIExhVaE","title":"Errors","pathname":"/errors","siteSpaceId":"sitesp_qCa19","description":"In the section we provide more details about the errors and the standardisation we use"},{"id":"-MVLpRFtVOR0eC-F_z4V","title":"Testing (important)","pathname":"/testing-important","siteSpaceId":"sitesp_qCa19","description":"This section provides more details on how you should test the integration before going live"},{"id":"2NtpSEdgq0KWoD9oG3FX","title":"Validation & Data","pathname":"/validation-and-data","siteSpaceId":"sitesp_qCa19","description":"A few data lists that you may find handy while integrating with us"},{"id":"-MR-w9GSWde-8e9kjtVR","title":"Rates","pathname":"/endpoints/rates","siteSpaceId":"sitesp_qCa19","description":"If you want to send a packages from a point A to a point B, you would probably want to know first what is the cost of it, and what are the different options in order to send your package.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"-MZJtnD5TuO87UJwO5LS","title":"Get Rates","pathname":"/endpoints/rates/get-rates","siteSpaceId":"sitesp_qCa19","description":"Generate rates for all enabled carriers by providing a route (A to B)","breadcrumbs":[{"label":"Endpoints"},{"label":"Rates"}]},{"id":"-MVMV-axhgwJGe3dIgqW","title":"Get Rate","pathname":"/endpoints/rates/get-rate","siteSpaceId":"sitesp_qCa19","description":"This request returns the information of a single rate","breadcrumbs":[{"label":"Endpoints"},{"label":"Rates"}]},{"id":"-MPj-U0gL2PiORthxD2_","title":"Shipments","pathname":"/endpoints/shipments","siteSpaceId":"sitesp_qCa19","description":"","breadcrumbs":[{"label":"Endpoints"}]},{"id":"-MYe2Qgldr1ArymZseg4","title":"Create Shipment","pathname":"/endpoints/shipments/create-shipment","siteSpaceId":"sitesp_qCa19","description":"Creating a shipment, requires the sender's address, recipient's address, and a parcel (one or more items and their related information). Find below more details on how you can create a shipment","breadcrumbs":[{"label":"Endpoints"},{"label":"Shipments"}]},{"id":"q0lB29x3sPKS8fnWWhhp","title":"Create Shipment for Locker","pathname":"/endpoints/shipments/create-shipment-for-locker","siteSpaceId":"sitesp_qCa19","description":"Creating a shipment, requires the sender's address, recipient's address, and a parcel (one or more items and their related information). Find below more details on how you can create a shipment","breadcrumbs":[{"label":"Endpoints"},{"label":"Shipments"}]},{"id":"S1UVjZDdvVZkRUbfBjef","title":"Import Shipment","pathname":"/endpoints/shipments/import-shipment","siteSpaceId":"sitesp_qCa19","description":"Importing a shipment, requires the sender's address, recipient's address, and a parcel (one or more items and their related information). Find below more details on how you can import a shipment","breadcrumbs":[{"label":"Endpoints"},{"label":"Shipments"}]},{"id":"b75IkZPeceOI6T9esNuQ","title":"Update Shipment","pathname":"/endpoints/shipments/update-shipment","siteSpaceId":"sitesp_qCa19","description":"Find below more details on how you can update a shipment","breadcrumbs":[{"label":"Endpoints"},{"label":"Shipments"}]},{"id":"-MUA9EYu7KBKTdEvQ_OU","title":"Get shipments","pathname":"/endpoints/shipments/get-shipments","siteSpaceId":"sitesp_qCa19","description":"Get all the shipments created by your API key","breadcrumbs":[{"label":"Endpoints"},{"label":"Shipments"}]},{"id":"-MUA8EcDtXMFlXPN2p_r","title":"Get shipment","pathname":"/endpoints/shipments/get-shipment","siteSpaceId":"sitesp_qCa19","description":"Returns a single shipment's information","breadcrumbs":[{"label":"Endpoints"},{"label":"Shipments"}]},{"id":"-MUA82kT-cJFu4apzUP8","title":"Cancel Shipment","pathname":"/endpoints/shipments/cancel-shipment","siteSpaceId":"sitesp_qCa19","description":"This endpoint can be used to cancel a shipment. In order to cancel a shipment you have to provide as path variable the id of the shipment that needs to be cancelled","breadcrumbs":[{"label":"Endpoints"},{"label":"Shipments"}]},{"id":"IdkjCFIhRvGkazAziVUf","title":"Tracking","pathname":"/endpoints/shipments/tracking","siteSpaceId":"sitesp_qCa19","description":"These endpoints can be used to get and update the shipment tracking information","breadcrumbs":[{"label":"Endpoints"},{"label":"Shipments"}]},{"id":"Gu1wG9uyqqV6zAc2sExH","title":"Label Print Format","pathname":"/endpoints/shipments/label-print-format","siteSpaceId":"sitesp_qCa19","description":"This page provides an overview of the different supported label options for each courier and specifies the accepted values for the create shipment parameter `label_print_format`.","breadcrumbs":[{"label":"Endpoints"},{"label":"Shipments"}]},{"id":"0YxFhfgfwGWU5Xl8OkLF","title":"Incoming Orders","pathname":"/endpoints/incoming-orders","siteSpaceId":"sitesp_qCa19","description":"Every time that one of your customers creates a new order in your e-commerce store or marketplace, shiplemon allows you to relate your orders with your shipments and manage your workflows.","breadcrumbs":[{"label":"Endpoints"}]},{"id":"jIYI1IxZHT0gHSIl23XU","title":"Create Incoming Order","pathname":"/endpoints/incoming-orders/create-incoming-order","siteSpaceId":"sitesp_qCa19","description":"Creating an incoming order","breadcrumbs":[{"label":"Endpoints"},{"label":"Incoming Orders"}]},{"id":"XDs2toOlxrUhNoIKhb5Z","title":"Get incoming order","pathname":"/endpoints/incoming-orders/get-incoming-order","siteSpaceId":"sitesp_qCa19","description":"","breadcrumbs":[{"label":"Endpoints"},{"label":"Incoming Orders"}]},{"id":"kegq9s8fv3q3SdqCyPky","title":"Set incoming order state","pathname":"/endpoints/incoming-orders/set-incoming-order-state","siteSpaceId":"sitesp_qCa19","description":"Each order has a state. There are several state that categorise an order based on the state of it (New, Processing, Completed, Cancelled)","breadcrumbs":[{"label":"Endpoints"},{"label":"Incoming Orders"}]},{"id":"-MR5FINdWoSMpq3oB_Yn","title":"Help Center","pathname":"/support/help-center","siteSpaceId":"sitesp_qCa19","description":"For more questions about the restricted items, and the limitations please have a look","breadcrumbs":[{"label":"Support"}]}]}