CmClickpost is a wrapper gem to clickpost.ai. Using this gem you can integrate Clickpost's create order API and tracking API to your project seamlessly.
Add this line to your application's Gemfile:
gem 'cm_clickpost'And then execute:
$ bundle install
Or install it yourself as:
$ gem install cm_clickpost
You need to create initializers/cm_clickpost.rb file and pass the username and API keys provided to you by Clickpost at the time of registration.
CmClickpost.setup([:clickpost_username], [:clickpost_api_key], Rails.env)To create a forward order with Clickpost you need to use the Shipment module provided with this gem. This uses Clickpost's Create Order V3 API. You have to pass the necessary information to create the order.
You can read the official documentation about this API here.
shipment.pickup_address({
pickup_name: string,
pickup_phone: string,
pickup_pincode: string,
pickup_address: string,
pickup_time: DateTime object in iso8601 format,
pickup_city: string,
pickup_state: string,
pickup_country: string,
email: string,
tin: string
})shipment.drop_address({
drop_address: string,
drop_phone: string,
drop_country: string,
drop_state: string,
drop_pincode: string,
drop_city: string,
drop_name: string,
drop_email: string
})shipment.order_details({
height: int (in cm),
order_type: "COD" or "PREPAID",
invoice_value: string,
invoice_number: string,
invoice_date: string (yyyy-mm-dd),
reference_number: string,
length: int (in cm),
breadth: int (in cm),
weight: int (in grams),
courier_partner: int (ID of the courier partner that you want to make the order with),
cod_value: double (if COD is given as order_type)
})In case there are multiple products, wrap this in a loop.
shipment.product_details({
product_url: string,
price: double,
description: string,
quantity: int,
sku: string
})shipment.gst_info({
seller_gstin: string,
taxable_value: double,
is_seller_registered_under_gst: bool,
place_of_supply: string,
hsn_code: string,
enterprise_gstin: string,
gst_total_tax: double,
igst_amount: double,
cgst_amount: double,
invoice_reference: string,
})shipment.additional_info({
label: bool,
gst_number: string,
account_code: int (account_code is generated when you add a courier partner in clickpost),
order_id: string
})shipment.return_address({
name: string,
phone: string,
pincode: string,
address: string,
city: string,
state: string,
country: string,
})After passing these values simply call create_shipping_order and the order will be placed.
shipment.create_shipping_orderThis method will return the response object in JSON format. From this you can extract the waybill, shipping label pdf link etc. Check out the documentation to learn more.
Clickpost provides order tracking in two ways, polling and using webhooks. Tracking using polling can be done using this gem.
Using Shipment Module you can use polling to get the latest tracking information from Clickpost.
CmClickpost::Shipment.track(waybill: string, courier_partner_id: int)This will return the track object. You can learn about the response here.
You can use the documentation to use webhooks for real-time tracking. Find about it more here.
After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cm_clickpost. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the CmClickpost project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.