Shipper Integration: Postmen

Shipper Integration: Postmen

Postmen Integration Help

If you do not already have an Postmen account you can contact them here - https://www.postman.com/postman-account/

Our Platform integrates seamlessly with Postmen account to allow the booking in of shipments, the printing of labels and the passing of tracking references. 

If you have a Postment account all you need to do is add your API Key & Shipper Account ID and ensure the "Is Enabled" tickbox is checked.

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

You can also set multiple options that you can enable once you have connected with Postmen such as Shipment Strategy (Options for Individual or Combined Parcels), Dimesnions Strategy, Service Type and an option to enable the tickbox to use thre Cheapest Service.  

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"
    }
  }
Still Need Help?
You can access our extensive knowledge base or raise a ticket with our technical support teams using the buttons below



    • Related Articles

    • Shipper Integration | WIzmo

      Wizmo Integration Help If you do not already have a Wizmo account you can contact them here - Wizmo Account Setup Our Platform integrates seamlessly with your Shipper account to allow the booking in of shipments, the printing of labels and the ...
    • Shipper Integration | Express Bird

      Express Bird Integration Help If you do not already have an Express Bird account you can contact them here - Express Bird Account Setup Our Platform integrates seamlessly with your Shipper account to allow the booking in of shipments, the printing of ...
    • Shipper Integration | Nucleus

      Nucleus Integration Help If you do not already have a Nucleus account you can contact them here - Nucleus Account Setup Our Platform integrates seamlessly with your Shipper account to allow the booking in of shipments, the printing of labels and the ...
    • Shipper Integration: Estafeta

      Estafeta Integration Help If you do not already have a Estafeta account you can contact them here - Estafeta Account Setup Our Platform integrates seamlessly with your Shipper account to allow the booking in of shipments, the printing of labels and ...
    • Shipper Integration | Huxloe Logistics

      Huxloe Logistics Integration Help If you do not already have a Huxloe Logistics account you can contact them here - Huxloe Account Setup Our Platform integrates seamlessly with your Shipper account to allow the booking in of shipments, the printing ...