Integration between Ongoing WMS and Zhipster
Zhipster is a SaaS solution for delivery and shipping management.
Features
Generate labels directly from Ongoing WMS
You can create shipments in Zhipster based on an order in Ongoing WMS. The integration supports return shipments as well. All label information (address, number of packages, etc.) can be entered into Ongoing WMS, and then transferred to Zhipster at the click of a button.
When the shipment has been created, Ongoing WMS will receive a response from Zhipster containing the label and tracking information.
Default setup
The order is sent to Zhipster when the Send button is pressed in Ongoing WMS.
If it validates, a label will be returned to Ongoing WMS immediately, which is printed automatically.
Preparations
The following data is required to set up an integration with Zhipster:
- API Key
After you have gathered this information, please see this guide on how to set up an integration between Ongoing WMS and Zhipster.
Mapping
Zhipster shipment - Ongoing WMS Order
| Zhipster | Ongoing WMS | |
|---|---|---|
| ShipmentType | "Standard" | |
| ShipmentStatus | "Registered" | |
| ShipmentKey | OrderInfo⇒OrderId (+ "-R" for returns) | |
| ShipmentTemplateID | ReturnTransporter⇒WaybillTemplate or Financial⇒WaybillTemplate | |
| TransportInformation | ||
| ForwarderEDI | ||
| ReserveShipment | false | |
| TransferShipment | false | |
| RequestPickup | false | |
| ForwarderID | ReturnTransporter⇒TransporterCode or Transporter⇒Code | |
| ForwarderName | ReturnTransporter⇒TransporterName or Transporter⇒TransporterName | |
| TermsOfDeliveryID | OrderInfo⇒TermsOfDelivery (None* for returns) | |
| FreightPaymentBy | based on Financial⇒TransportPaymentType | |
| FreightPaymentThirdParty | TransportPayer⇒CustomerCode (if FreightPaymentBy is ThirdParty) | |
| DeliveryInstructions | OrderInfo⇒DeliveryInstruction (None* for returns) | |
| ShippingReference | OrderInfo⇒GoodsOwnerOrderNumber | |
| DeliveryReference | OrderInfo⇒ConsigneeOrderNumber | |
| IsReturnShipment | true for returns, false otherwise | |
| Shipper | ||
| PartyID | Integration settings ⇒ Party ID of shipper in Zhipster | |
| Name | [GoodsOwnerInfo⇒Name] c/o [Name of warehouse] | |
| AddressAndContact | Address details of the goodsowner's default warehouse. | |
| Consignee | ||
| PartyID | Consignee⇒CustomerNumber | |
| Name | Consignee⇒Name | |
| Address | ||
| Name | Consignee⇒Name | |
| Street1 | Consignee⇒Address | |
| Street2 | Consignee⇒Address2 | |
| City | Consignee⇒City | |
| ZipCode | Consignee⇒PostCode | |
| CountryCode | Consignee⇒CountryCode | |
| StateCode | Consignee⇒CountryStateCode | |
| Contact | ||
| Name | Consignee⇒Name | |
| PhoneNumber | OrderInfo⇒SMSNotification (or OrderInfo⇒TelephoneNotification if SMSNotification is empty) | |
| EmailAddress | OrderInfo⇒EmailNotification | |
| Commercial | ||
| PartyID | ReturnTransporter⇒TransporterContractEdiCode or Financial⇒PriceListCode | |
| Name | GoodsOwnerInfo⇒Name | |
| Address | ||
| Name | GoodsOwnerInfo⇒Name | |
| Street1 | GoodsOwnerInfo⇒Address | |
| Street2 | GoodsOwnerInfo⇒Address2 | |
| City | GoodsOwnerInfo⇒City | |
| ZipCode | GoodsOwnerInfo⇒PostCode | |
| CountryCode | GoodsOwnerInfo⇒CountryCode | |
| Contact | ||
| Name | GoodsOwnerInfo⇒Name | |
| PhoneNumber | GoodsOwnerInfo⇒TelePhone | |
| EmailAddress | GoodsOwnerInfo⇒Email | |
| GoodsItems | Each GoodsItem is mapped as follows | |
| GoodsItemKey | GoodsItem⇒Id | |
| NumberOfPackages | GoodsItem⇒NumberOfPackages | |
| PackageTypeID | GoodsItem⇒PackageTypeCode | |
| ItemDescription | GoodsItem⇒GoodsCategory | |
| WeightInKg | GoodsItem⇒Weight (or PackageTyperArr;Weight if GoodsItem⇒Weight is 0) | |
| LengthInCm, WidthInCm, HeightInCm | From GoodsItem if all three fields on GoodsItem are non-zero, otherwise all three are taken from PackageType. | |
| VolumeInM3 | GoodsItem⇒Volume | |
| LoadingMeters | GoodsItem⇒LoadMeters | |
| PrintSettings | None* if Integration settings ⇒ Printing strategy = "None". Otherwise the following, once for each document type. | |
| Document | "ParcelLabel", "ConsignmentNote" | |
| PrintMode | "Url" (The URL in response is used by the integration to fetch the PDF and print it.) | |
| NumberOfCopies | "1" | |
| DispatchOrder | None* for returns, otherwise the following. | |
| DispatchOrderKey | OrderInfo⇒OrderId | |
| DispatchOrderNumber | OrderInfo⇒GoodsOwnerOrderNumber | |
| DispatchOrderLines | Each picked order line is mapped as follows | |
| DispatchLineKey | PickedOrderLine⇒OrderLineSystemId | |
| DispatchLineNumber | PickedOrderLine⇒ExternalOrderLineCode (or OrderLineSystemId if ExternalOrderLineCode is empty) | |
| ConnectedLineKey | PickedOrderLine⇒ParentOrderLineId (None* if the order line is not part of a structure.) | |
| RequestedQuantity | PickedOrderLine⇒OrderedNumberOfItems | |
| DispatchedQuantity | PickedOrderLine⇒PickedNumberOfItems | |
| ArticleDescription | PickedOrderLine⇒Article⇒Name | |
| SuppliersArticleNumber | PickedOrderLine⇒Article⇒ArticleNumber | |
| MeasurementUnit | PickedOrderLine⇒Article⇒ArticleUnitCode | |
| WeightInKg | PickedOrderLine⇒Article⇒Weight | |
| NetWeightInKg | PickedOrderLine⇒Article⇒NetWeight | |
| LengthInCm | PickedOrderLine⇒Article⇒Length * 100 | |
| WidthInCm | PickedOrderLine⇒Article⇒Width * 100 | |
| HeightInCm | PickedOrderLine⇒Article⇒Height * 100 | |
| VolumeInM3 | PickedOrderLine⇒Article⇒Volume | |
None* = those fields are not in the default set up, but it is easy to set them to any field in Ongoing WMS.