Shipper Integration | EasyShip

Shipper Integration | EasyShip

OMS now integrates with EasyShip shipping API so that when an item is dispatched using a scan point, a shipment is created in EasyShip system and a EasyShip shipping label is created for the user. You must have an account with EasyShip before you can configure a shipping integration.

Set Up Instructions

Ensure the senders address is already configured on the EasyShip website. 

Obtain the API Key (Access Token) from the EasyShip account and enter this into the OMS settings page for the client.

The shipment strategy can be set to Individual parcels or Combined Parcels. Combined Parcels is the default strategy type and will be used if the field is left blank




Before running the integration or placing a order to be dispatched using EasyShip:

Ensure the items (or products) in the order have a valid weight and price set.

Ensure the shipping carrier on the order is set to 'Easyship'. 

Ensure the status on the order is set to Received.



How it Works

The integration obtains the courier with the cheapest rate and passes the id of the courier to the create shipment API call.

The shipment creation API call is in the format below



{
  "platform_name":"<Platform Name on Settinfs>",
  "platform_order_number":"<External Ref on Order>",
  "destination_country_alpha2":"<shipping country code in OMS>",
  "destination_city":"<Shipping address 4 in OMS>",
  "destination_postal_code":"<Shipping postcode in OMS>",
  "destination_state":"<Shipping address 5 in OMS>",
  "destination_name":"<Customer name in OMS>",
  "destination_address_line_1":"<Shipping address 1 in OMS>",
  "destination_address_line_2":"<Shipping address 2 in OMS>",
  "destination_phone_number":"<Customer telephone in OMS>",
  "destination_email_address":"<Customer Email in OMS>",
  "items":[
    {
      "description":"T<Item description in OMS>",
      "actual_weight":"<Item Weight>",
      "height":<Item Height>,
      "width":<Item Width>,
      "length":<Item Length>,
      "category":"accessory_no_battery",
      "declared_currency":"<Item Currency>",
      "declared_customs_value":"<Item value computed by integration>"
    }],
  "selected_courier_id":"<Courier Id obtained from rates API>"
}

Once the shipment is successfully created, the integration continues to query the API until a label is generated.

The shipment details are then saved in OMS.

    • Related Articles

    • Shipper Integration | ParcelHub

      Introduction This article has been created to show how to setup the Shipper Integration that Kornit X has built to connect to ParcelHub.  Setup To setup the ParcelHub integration, please head to your Dropship company and within the advanced settings ...

    • Shipper Integration | Nucleus

      Introduction This article has been created to show how to setup the Shipper Integration that Kornit X has built to connect to Nucleus, otherwise known as "ClickNShip". The following link takes you to the API documentation created by Nucleus - API ...

    • Shipper Integration | Paragon HDX

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to Paragon HDX.  Setup To setup the Paragon HDX integration, please head to your company and within the advanced settings head ...

    • Shipper Integration | GLS Spain

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to GLS Spain. Setup To setup the GLS Spain integration, please head to your company and within the advanced settings head to ...

    • Shipper Integration | Generic Label

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to a Generic Label. Setup To setup the Generic Label integration, please head to your company and within the advanced settings ...