Skip to content

General Use Cases

This section provides general guidance for using the Envase Connect Core API. For specific use case documentation, see:

API Overview

The Envase Connect Core API provides an interface for interacting with a TMS. The API supports common operations for managing shipments, equipment, drivers, locations, and related entities.

Creating Shipments

When creating shipments through the API, you can provide basic shipment information such as booking number, origin, destination, customer, and status. The API accepts JSON payloads and returns created shipment resources with their assigned identifiers.

Shipment Rules (Optional)

The API supports an optional rules object in shipment creation requests that allows applications to control TMS-specific behaviors. This feature is designed to provide flexibility for different integration scenarios.

Key Characteristics:

  • Optional: The rules object can be omitted entirely - it is not required for shipment creation
  • TMS-Specific: Not all TMS systems support rules; support varies by TMS implementation
  • Extensible: Different TMS systems may support different rule properties to meet their specific needs

Currently Supported Rules:

  • autoRate (boolean): Controls whether the TMS automatically rates shipment items.

Example Request with Rules:

{
  "bookingNumber": "BNL123456789",
  "customer": {
    "id": "1"
  },
  "destination": {
    "id": "7463"
  },
  "directionCode": "I",
  "origin": {
    "id": "11327"
  },
  "status": "open",
  "rules": {
    "autoRate": false
  }
}

For detailed information about using rules for Order Automation scenarios, see the Order Automation Use Cases documentation.

Important Notes:

  • Always check your TMS documentation to determine which rules are supported
  • The absence of the rules object results in default TMS behavior
  • Future TMS implementations may introduce additional rule properties