Shipper Integration | Postmen
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 already have a postmen account and should have the desired courier already configured on the postmen account.
OMS / Integration Settings
1. Obtain the API key from the clients Postmen account and enter into the required field in the Postmen Integration popup window in OMS.
2. Also obtain the shipper account id for the client's courier and enter into the field in OMS.
3. The use cheapest service flag allows the integration to perform rate calculation. If this flag is not ticked, then a valid Service Type should be entered.
4. The shipment origin country code should also be entered. This is a 3-letter country code.
5. The integration currently uses a default dimension of 20cm x 20cm x 20cm. Please if you require specific dimensions, please get in touch with your onboarder.
6. The integration supports a combined and a individual shipment strategy. A combined strategy combines all items in an order into a single shipment. An individual shipment strategy on the other hand places each parcels and quantity on an item into separate shipments. E.g An item with a parcel count of 2 in CPP and a quantity of 2 will be placed into 4 separate shipments.
7. Also enter the shipper's address into the appropriate fields.
Order and Product Requirements
All products in an order should have weight set in Grams and the RRP price set in the desired currency. Also note that when setting the price, the quantity should be set to 1.
The currency field on the company the integration is enabled on must also be set.
The shipping carrier on the order must be set to postmen
How it works
Once all required details are set, the integration uses the selected shipment strategy to construct the shipment data.
If the Use Cheapest Service flag is ticked in the OMS settings, the integration will find the cheapest rate/service on the courier set up for the customer in Postmen. It then add the service to the shipment data.
NB. Not all couriers allow rate calculation in Postmen. If unsure, please contact Postmen to find out if your courier allows rate calculation. If rate calculation is not allowed on the courier, then the desired service type/name must be entered for the integration to use
The integration then sends the shipment data to the Postmen API. If successful, the API creates a label in return for the user.
Please see below example of a shipment data constructed via the combined shipment strategy
{
"shipment": {
"ship_from": {
"contact_name": "Test name",
"company_name": "Custom Gateway",
"street1": "10 Pinewood Court",
"city": "Macclesfield",
"state": "Cheshire",
"postal_code": "SK10 2XR",
"country": "United Kingdom",
"phone": "07841458307",
"email": "test@test.com"
},
"ship_to": {
"contact_name": "Test address",
"street1": "28292 Daugherty Orchard",
"city": "Sacramento",
"state": "CA",
"postal_code": "94209",
"country": "USA",
"phone": "0771122334455",
"email": "anothertest@test.com"
},
"parcels": [
{
"description": "iPhone 6S Plus Tough Case Matte leo",
"box_type": "custom",
"weight": {
"value": 5.5,
"unit": "kg"
},
"dimension": {
"width": 20,
"height": 20,
"depth": 20,
"unit": "cm"
},
"items": [
{
"description": "iPhone 6S Plus Tough Case Matte leo",
"origin_country": "GBR",
"quantity": 2,
"price": {
"amount": 10.45,
"currency": "EUR"
},
"weight": {
"value": 1.5,
"unit": "kg"
},
"sku": "AUC3112170920143"
},
{
"description": "iPhone 6S Blue Plus Tough Case Matt",
"origin_country": "GBR",
"quantity": 1,
"price": {
"amount": 3,
"currency": "EUR"
},
"weight": {
"value": 2.5,
"unit": "kg"
},
"sku": "AUC3112170920143"
}
]
}
]
},
"service_type": "fedex_international_economy",
"shipper_account": {
"id": "6f43fe77-b056-45c3-bce4-9fec4040da0c"
},
"references": [
"1903191744HR7A8"
],
"customs": {
"purpose": "merchandise",
"billing": {
"paid_by": "recipient"
}
}
}
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 ...