EasyShip Shipping Integration

EasyShip Shipping Integration

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

    • MWW Supplier Integration

      Overview It is now possible to send orders directly to the MWW On Demand platform via the new Custom Gateway supplier integration. If you would like to take advantage of this feature, please contact Custom Gateway Support quoting your MWW API key. ...
    • Transglobal Express Shipping Integration

      OMS can integrate with Transglobal Express' shipping API so that when an item is dispatched using a scan point, a shipment is created in  Transglobal Express'  system and an official  Transglobal Express  shipping label is created for the user. You ...
    • Yodel Shipping Integration

      OMS can integrate with Yodel's shipping API so that when an item is dispatched using a scan point, a shipment is created in Yodels system and an official Yodel shipping label is created for the user. You must have an account with Yodel before you can ...
    • Australia Post Shipping Integration

      OMS can integrate with Australia Posts shipping API so that when an item is dispatched using a scan point, a shipment is created in  Australia Posts  system and an official  Australia Post  shipping label is created for the user. You must have an ...
    • ShipStation API Shipping Integration

      OMS can integrate with the ShipStation shipping API so that when an item is dispatched using a scan point, a shipment is created in the ShipStation system and a shipping label for one of your enabled ShipStation carriers is generated . You must have ...