NOTE:  In your system Orders may be replaced with Shipment.

Techship is a cloud-based application that is fully integrated with your WMS and provides a single user interface and a single API interface to simplify both use and integration.

A key requirement for Techship integration is real-time access to the orders in the WMS system.  Allowing Techship to pull and process the orders at user request.  Techdinamics supports two standards when integrating your WMS with Techship, SOAP or REST web services. 

This document outlines the information that either the SOAP or REST API needs to support in order to make the integration a success.

Orders Retrieval

The first API call required by Techship is a call to retrieve warehouse orders stored in the WMS system. Techship required the ability to extract orders as a collection based on 

  • Transaction Number
    This would be your WMS internally assigned a number to the warehouse order
  • Customer Order Number
    Normally this would be your customer order number.  The warehouse orders ID that was provided by your customer
  • Batch Number
    A batch number assigned by the WMS when processing a group of orders together.  This is a very common approach used for e-commerce order processing.

During an API call, Techship will provide the type of reference is using to retrieve the information from the WMS system.

The message back should have the following structure 

  • Warehouse Order Collection
    Batch requests will require to return multiple orders.  This collection will contain all the orders or references to the orders.
    • Warehouse Order
      • Header Information
        • Order Number (Mandatory, Unique)
        • Customer Order (Reference) number (Mandatory, Unique)
        • Customer PO (Optional, i.e. optional additional order number to display on labels and UI)
        • Order Date (Mandatory)
        • Ship-to Name (Mandatory)
        • Ship-to Address 1 (Mandatory)
        • Ship-to Address 2 (Optional)
        • Ship-to Address 3 (Optional)
        • City (Mandatory)
        • State/Province code (i.e. AB, SK, ON, etc.) (Mandatory)
        • Country code (i.e. CA, US, etc.) (Mandatory)
        • Postal code (Mandatory)
        • Ship-to Phone (Conditional, required for some carriers/services)
        • Ship-to Email (Optional)
        • Sequence Number (Optional).  Using in batches to print labels in a specific order.  Helps correlate labels with packing slips.
        • Carrier code (Optional)
        • Carrier service (Optional)
        • Carrier Billing Account (Optional)
        • Terms (Optional)
        • Signature Required (Boolean, Optional)
        • Adult Signature Required  (Boolean, Optional)
        • Collect On Delivery (Boolean, Optional)
        • COD Amount (Decimal, Conditional, required if COD=true)
        • COD Method (Optional)
        • Declared Value (Decimal, Optional)
        • Oversize (Boolean, Optional)
        • Unpackaged (Boolean, Optional)
        • Mailing Tube(Boolean, Optional)
        • Additional Parameters Collection (Optional) - used if customers request custom labels creation/printing, can be used for fields like DC number, Store Number, etc.
          • Code (Mandatory)
          • Value (Mandatory)
      • Package collection (Optional)
        When the order is packaged in the WMS prior to being passed to Techship this collection will contain information on the packages that were packaged their dimensions, weight, etc.  Normally each package will be updated by Techship with its own tracking number after the shipment is sent.
        • Package Information 
          • Package ID (Conditional, either Package ID or Package Sequence Number required)
          • Package Sequence Number (within Order, Conditional, either Package ID or Package Sequence Number required)
          • Package Weight (Mandatory)
          • Package Dimensions (H x L x W) (Optional)
          • Package UCC128 code (Optional, pass if generated on WMS side)
          • Additional Parameters Collection (Optional) - used if customers request custom labels creation/printing, can be used for additional SKU info, Color, Size, etc.
            • Code (Mandatory)
            • Value (Mandatory)
          • Item Collection (Optional)
            Item information is used when creating packing slips and international shipments
            • Item Information (Optional)
              • SKU (Mandatory)
              • Lot (Optional)
              • Description (Optional)
              • Quantity (Mandatory)
              • Serial Number (Optional)
              • HSS
              • Commercial Invoice Price (not used now)
              • Country of origin (not use now)

Order Update

Called by Techship when the customer finalizes order/batch in techSHIP to update tracking, freight charge, UCC, etc.

  • Update Order Call (mandatory)
    • Order Number (Conditional, either Order Number or Customer Order required)
    • Customer Order(Conditional, either Order Number or Customer Order required)
    • Tracking Number (mandatory)
    • Carrier Code (Optional)
    • Carrier Service (Optional)
    • Carrier Billing Account (Optional)
    • Freight Charge (Optional)
    • Fuel Surcharge (Optional)
    • Close Order (Boolean, Optional - or additional service method to close order needs to be exposed)
    • Close/Confirmation Date (DateTime, Optional)
  • Update Package Call (Optional) - this call and update order call can be combined in a single call if required
    • Package ID (Conditional, either Package ID or Package Sequence number with (Order Number or Customer Order) required to uniquely identify package)
    • Package Sequence Number (Conditional, see above)
    • Order Number (Conditional, see above)
    • Customer Order (Conditional, see above)
    • Tracking Number (Optional)
    • UCC128 Code (Optional, used for custom labels, returned if UCC128 generated on Techship side)