Ship&Co. Shipping Integration

Ship&Co. Shipping Integration

OMS can integrate with Ship&Co shipping API so that when an item is dispatched using a scan point, a shipment is created in Ship&Co's system and a Ship&Co shipping label is created for the user. You must have an account with Ship&Co
 before you can configure a shipping integration. 

The integration is currently only enabled for Yamato Carriers. Also please note that the Ship&Co API can only be used for shipments within Japan when using Yamato Carrier. If the client needs to ship outside of Japan using Ship&Co, then they would need to use a different carrier that supports international shipment.

Set Up Instructions


The access token (or api key)  can be obtained/created from the Ship&Co Dashboard page, on the settings tab.  Once obtained, enter this into the Ship&Co Settings page in OMS.


For Yamato Carrier, enter the Yamato Carrier Key and the Yamato Carrier Freight Number into the respective fields on the settings page in OMS.  Both of these information should be provided by the client and are required if the carrier has not been previously registered on the Ship & Co dashboard.


Enter the Carrier Type. For Yamato, this should be set to 'yamato'


If the carrier is already registered on the Ship & Co dashboard, obtain the carrier id form the client  and enter in the Carrier ID field in OMS. Also ensure the 'Carrier Registered' field is ticked in OMS. However if the carrier is not previously registered, the 'Carrier Registered' field should NOT be ticked and the integration will attempt to register the carrier using the provided carrier details (i.e 'Yamato Carrier Key' and 'Yamato Carrier Freight Number' for Yamato carrier). The integration will also enter in the carrier id obtained from the registration into the Carrier ID field in OMS.


The shipment strategy can be set to Individual parcels or Combined Parcels. Combined Parcels is the default strategy type.


A dimensions strategy called 'Client\ShipAndCo\ShipAndCoDimensionsStrategy'  can be entered into the Dimensions Strategy field. This is also the default value and will be used if the field is left blank



Weight must be set for each item. Also price must be set for each item. This would typically be the unit sale price or Retail price on the order items.



For Yamato Carriers, addresses in OMS settings and also on the order must be Japanese addresses and the address should also be in Japanese.


Please see below example shipment request. This should give an indication of what fields must be populated in the order and in OMS settings.




{
  "to_address": {
    "full_name": "太郎山田", <Customer name on order>
    "company": "", <Company name on order if available>
    "email": "yamada.taro@demo.com", <Customer email on order>
    "phone": "08012341234", <Customer telephone number on order>
    "country": "JP", <Country code on the order>
    "address1": "京都市東山区", <Address Line 1 on the order>
    "address2": "西海子町,神宮道", <Address Line 2 and 3 on the order>
    "province": "京都府", <Region on the order>
    "zip": "6050012", <Postcode on the order>
    "city": ""<Town or City on the order if available>
  },
  "from_address": {
    "full_name": "Karen Bailey", <FullName in OMS settings>
    "company": "株式会社ACME", <Company Name in OMS settings if available>
    "email": "yamada.hanako@acme.com", <Email in OMS if available>
    "phone": "08012341234", <Telephone in OMS settings if available>
    "country": "JP", <Country in OMS settings. Notice this hsould be the country code and not the full country name>
    "address1": "中央区", <Address 1 in OMS settings>
    "address2": "日本橋堀留町", <Address 2 in OMS settings>
    "province": "東京都", <Province in OMS settings>
    "zip": "1030012", <Zip in OMS settings>
    "city": ""
  },
  "products": [
    {
      "name": "iPhone 6S Tough Case Black Matte leopard in leaves.jpg",
      "quantity": 1,
      "price": 250,
      "hs_code": null,
      "hs_description": "",
      "origin_country": "JP"
    }
  ],
  "parcels": [
    {
      "weight": "0.07",
      "amount": "1",
      "width": 20,
      "height": 20,
      "depth": 20
    }
  ],
  "customs": {
    "duty_paid": false,
    "content_type": "MERCHANDISE"
  },
  "setup": {
    "test": true,
    "currency": "",
    "date": "",
    "service": "yamato_taqbin_collect",
    "carrier": "yamato"
  }
}






    • 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. ...
    • Hermes Shipping Integration

      If you do not already have a Hermes account you can easily get one by completing the simple form by clicking the green 'request more details' button on this link. A representative from Hermes will be in touch to set up an account taking advantage of ...
    • 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 ...
    • Postmen Shipping Integration

      OMS now integrates with Postmen shipping API so that when an item is dispatched using a scan point, a shipment is created in Postmen's system and a Postmen shipping label is created for the user. Any client wishing to use the integration should ...
    • 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 ...