OrderDetails

OrderDetails API

The OrderDetails endpoint allows users to send updates to existing orders that have already been transmitted through the Orders endpoint. Updates provided here will replace any existing details associated with the specified ShipmentNumber.

:::caution[Caution]
Important Note: Since this API call overrides any current data for the specified ShipmentNumber, only use this for updates that are intended to replace previously submitted information.
:::

Input:

• Authentication:

  • UserName: User's unique identifier.
  • ClientCode: Code associated with the client.
  • AuthenticationID: Unique session ID for authentication.

• Order Identification:

  • ShipmentNumber: Required. The unique identifier of the shipment to be updated, which links this update to the original order.
  • InternalBOLNumber: An optional internal reference for tracking the Bill of Lading within your system.

• Updated Line Items:

  • Items: Array of shipment items that replaces the existing items for the order. Each item must include:
    • ShippingUnits: Number of units being shipped.
    • PKGType: Type of packaging (e.g., box, pallet).
    • Description: Description of the item(s).
    • NMFC: National Motor Freight Classification code.
    • ClassNum: Freight class number.
    • Weight: Weight of the item.
    • Haz: Specifies if the item is hazardous (true or false).

Output:

• ErrorMessage: If an error occurs, this field contains the error message; otherwise, it will be null.
• Accepted: Indicates if the update was successfully processed (true or false).