Jump to

• Request
• Response

Retrieve the multistop savings matrix

post

/custom-actions/multistopSavingsMatrix

Given a bulk plan GID returns iterations of the candidate combined shipments with savings, plus the list of pairable shipment details.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• bulkPlanGid(required): string

{
    "required":[
        "bulkPlanGid"
    ],
    "properties":{
        "bulkPlanGid":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The successful response containing iterations and shipments.

Body ()

Root Schema : MultistopSavingsMatrixResponse

Type: object

Show Source

• iterations: array iterations
• shipments: array shipments

{
    "properties":{
        "iterations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Iteration"
            }
        },
        "shipments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Shipment"
            }
        }
    }
}

Nested Schema : iterations

Type: array

Show Source

• Array of: object Iteration

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Iteration"
    }
}

Nested Schema : shipments

Type: array

Show Source

• Array of: object Shipment

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Shipment"
    }
}

Nested Schema : Iteration

Type: object

Show Source

• combinedShipment: combinedShipment
  The proposed combined shipment for this iteration, if any.
• iterationNo(required): integer
  The 1-based iteration number.
• savingsMatrix: savingsMatrix
• shipmentGids(required): array shipmentGids
  The shipments considered in this iteration.

{
    "type":"object",
    "properties":{
        "combinedShipment":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Shipment"
                }
            ],
            "nullable":true,
            "description":"The proposed combined shipment for this iteration, if any."
        },
        "iterationNo":{
            "type":"integer",
            "description":"The 1-based iteration number."
        },
        "savingsMatrix":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SavingsMatrix"
                }
            ]
        },
        "shipmentGids":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"The shipments considered in this iteration."
        }
    },
    "required":[
        "iterationNo",
        "shipmentGids"
    ]
}

Nested Schema : combinedShipment

The proposed combined shipment for this iteration, if any.

Match All

The proposed combined shipment for this iteration, if any.

Show Source

• object Shipment

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Shipment"
        }
    ],
    "nullable":true,
    "description":"The proposed combined shipment for this iteration, if any."
}

Nested Schema : savingsMatrix

Match All

Show Source

• object SavingsMatrix

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SavingsMatrix"
        }
    ]
}

Nested Schema : shipmentGids

Type: array

The shipments considered in this iteration.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"The shipments considered in this iteration."
}

Nested Schema : Shipment

Type: object

Show Source

• combinedFrom: array combinedFrom
  The shipment IDs that were combined to form this shipment (empty for base shipments).
• equipmentGroup: string
  The equipment group used for the shipment.
• name: string
  The name or identifier of the shipment. It follows a specific format: Pairable TShipment: ( -> )
• orderGids: array orderGids
  The list of Order GIDs that are part of the shipment.
• rateOffering: string
• serviceProvider: string
• shipmentId: string
  The shipment ID which could be a temporary ID.
• stops: array stops

{
    "type":"object",
    "properties":{
        "combinedFrom":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"The shipment IDs that were combined to form this shipment (empty for base shipments)."
        },
        "equipmentGroup":{
            "type":"string",
            "description":"The equipment group used for the shipment.",
            "nullable":true
        },
        "name":{
            "type":"string",
            "description":"The name or identifier of the shipment. It follows a specific format: Pairable TShipment: <shipment_id> (<origin> -> <destination>)"
        },
        "orderGids":{
            "type":"array",
            "description":"The list of Order GIDs that are part of the shipment.",
            "items":{
                "type":"string"
            }
        },
        "rateOffering":{
            "type":"string",
            "nullable":true
        },
        "serviceProvider":{
            "type":"string",
            "nullable":true
        },
        "shipmentId":{
            "type":"string",
            "description":"The shipment ID which could be a temporary ID."
        },
        "stops":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Stop"
            }
        }
    }
}

Nested Schema : combinedFrom

Type: array

The shipment IDs that were combined to form this shipment (empty for base shipments).

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"The shipment IDs that were combined to form this shipment (empty for base shipments)."
}

Nested Schema : orderGids

Type: array

The list of Order GIDs that are part of the shipment.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of Order GIDs that are part of the shipment.",
    "items":{
        "type":"string"
    }
}

Nested Schema : stops

Type: array

Show Source

• Array of: object Stop

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Stop"
    }
}

Nested Schema : Stop

Type: object

Show Source

• locationGid(required): string
• stopNumber(required): integer

{
    "type":"object",
    "properties":{
        "locationGid":{
            "type":"string"
        },
        "stopNumber":{
            "type":"integer"
        }
    },
    "required":[
        "locationGid",
        "stopNumber"
    ]
}

Nested Schema : SavingsMatrix

Type: object

Show Source

• firstShipment: string
• savingsValue: number (double)
  The cost/distance saving for combining the shipments.
• secondShipment: string

{
    "properties":{
        "firstShipment":{
            "type":"string"
        },
        "secondShipment":{
            "type":"string"
        },
        "savingsValue":{
            "type":"number",
            "format":"double",
            "description":"The cost/distance saving for combining the shipments."
        }
    }
}

400 Response

The default response.

Body ()

Root Schema : errorResponse400

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

404 Response

The default response.

Body ()

Root Schema : errorResponse404

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  The HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"The HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top