Skip to content

Order Automation Use Cases

This section documents the usage of Envase Connect Core API for Order Automation workflows. Order Automation systems integrate with the Envase Connect Core API to create and manage shipments programmatically and control various aspects of shipment processing.

For general API usage guidelines, refer to the General Use Cases section.

Overview

Order Automation systems require flexible integration capabilities to support diverse business workflows and processing requirements. Envase Connect Core API provides mechanisms for controlling how shipments are created and processed in the TMS.

Controlling Shipment Processing with Rules

Order Automation systems often need fine-grained control over how shipments are processed in the TMS. Envase Connect Core API provides an optional rules object in the shipment creation request that allows applications to specify TMS-specific processing rules.

Important Considerations

  • The rules object is optional and may be omitted entirely
  • Support for rules is TMS-specific - not all TMS systems support rules
  • The rules object is extensible - different TMS systems may support different rule properties

Controlling Auto-Rating Behavior

A common scenario for Order Automation is controlling whether the TMS should automatically rate a new shipment. By default, some TMS systems may automatically calculate rates and create line items when a shipment is created. However, Order Automation may want to prevent this behavior because a subsequent request is intended to create or update the shipment items.

Disabling Auto-Rating

To prevent the TMS from automatically rating a shipment and possibly creating/updating line items during shipment creation, include the rules object with autoRate set to false:

Example Request Body:

{
  "bookingNumber": "BNL123456789",
  "comments": "Order automation shipment - no auto-rate",
  "customer": {
    "id": "1"
  },
  "destination": {
    "id": "7463"
  },
  "directionCode": "I",
  "expedite": false,
  "hazmat": false,
  "masterBL": "MBOL345",
  "origin": {
    "id": "11327"
  },
  "status": "open",
  "rules": {
    "autoRate": false
  }
}

Default Behavior

If the rules object is omitted or autoRate is not specified, the TMS will use its default behavior, which may include automatic rating depending on the TMS configuration.

Future Rule Extensions

The rules object is designed to be extensible. Future versions of the API or specific TMS implementations may support additional rules.