Order fulfillment

The order fulfillment app is available in one modeling language as a Mixed Integer Problem (MIP). You can also choose to make customizations to the model by instantiating the app first.

Nextmv SDK
- Default solver: HiGHS
- Marketplace subscription app IDs
  - Go: nextmv-order.fulfill.gosdk

Bash

nextmv community clone -a order-fulfillment-gosdk

Once you have the code locally, you can customize the model, run it locally and deploy it to Nextmv Platform.

Input

The input schema is a JSON payload defining the items, distribution centers, carrier capacities, and carrier delivery costs . Nextmv's tools are designed to operate directly on business data (in JSON) to produce decisions that are actionable by software systems. This makes decisions more interpretable and easier to test. It also makes integration with data warehouses and business intelligence platforms significantly easier. An input contains the following components:

Field name	Required	Data type	SI Unit	Description	Example
`carton_volume`	Yes	`float`	NA	The volume of a carton.	`{"carton_volume": 2.0}`
`items`	Yes	`array` of `item`	NA	The items which need to be fulfilled.	See `item`
`distribution_centers`	Yes	`array` of `distribution_center`	NA	The distribution centers available.	`{"depot": 0}`
`carrier_capacities`	Yes	`map` of `string` to `map` of `string` to `float`	NA	The capacities of each distribution center and carrier combination.	`{"carrier_capacites": {"distribution_center_1": "carrier1": 10.0, "carrier2": 25.0}}`
`carrier_delivery_costs`	Yes	`map` of `string` to `map` of `string` to `map` of `string` to `array` of `float`	NA	The cost of each carrier and distribution center combination by weight tier.	`{"carrier_delivery_costs": "distribution_center_1": {"carrier1": {"weight_tiers": [2,3], "weight_rate": [1.2, 3.4]}}}`

Item

Field name	Required	Data type	SI Unit	Description	Example
`item_id`	Yes	`string`	NA	The ID of the item.	`{"item_id": "book"}`
`quantity`	Yes	`float`	NA	The quantity needed of the item.	`{"quantity": 5}`
`unit_volume`	Yes	`float`	NA	The volume per unit of item.	`{"unit_volume": 0.1}`
`unit_weight`	Yes	`float`	NA	The quantity needed of the item.	`{"unit_weight": 0.6}`

Distribution center

Field name	Required	Data type	SI Unit	Description	Example
`distribution_center_id`	Yes	`string`	NA	The ID of the distribution center.	`{"distribution_center_id": "distribution_center_1"}`
`handling_cost`	Yes	float	NA	The handling cost at the distribution center.	`{"handling_cost": 1}`
`inventory`	Yes	map	NA	The inventory of each item available at the distribution center.	`{"inventory": {"book": 8, "sneaker": 5}}`

Here you can find a sample .json with the input schema:

JSON

{
  "carton_volume": 2.0,
  "items": [
    {
      "item_id": "book",
      "quantity": 5,
      "unit_volume": 0.1,
      "unit_weight": 0.6
    },
    {
      "item_id": "sneaker",
      "quantity": 2,
      "unit_volume": 0.2,
      "unit_weight": 0.8
    },
    {
      "item_id": "hydrating gel",
      "quantity": 12,
      "unit_volume": 0.1,
      "unit_weight": 0.01
    },
    {
      "item_id": "pressure cooker",
      "quantity": 2,
      "unit_volume": 0.4,
      "unit_weight": 1.5
    },
    {
      "item_id": "mattress",
      "quantity": 2,
      "unit_volume": 3,
      "unit_weight": 6.5
    }
  ],
  "distribution_centers": [
    {
      "distribution_center_id": "distribution_center_1",
      "handling_cost": 1,
      "inventory": {
        "book": 0,
        "sneaker": 8,
        "hydrating gel": 4,
        "pressure cooker": 3,
        "mattress": 5
      }
    },
    {
      "distribution_center_id": "distribution_center_2",
      "handling_cost": 0.3,
      "inventory": {
        "book": 10,
        "sneaker": 6,
        "hydrating gel": 9,
        "pressure cooker": 2,
        "mattress": 4
      }
    }
  ],
  "carrier_capacities": {
    "distribution_center_1": {
      "carrier1": 10.0,
      "carrier2": 25.0
    },
    "distribution_center_2": {
      "carrier1": 21.0,
      "carrier2": 18.0
    }
  },
  "carrier_delivery_costs": {
    "distribution_center_1": {
      "carrier1": {
        "weight_tiers": [
          2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30
        ],
        "weight_rates": [
          3.73, 3.76, 3.77, 3.77, 3.8, 3.88, 3.96, 4.05, 4.09, 4.11, 4.34, 4.58,
          4.62, 4.68, 4.69
        ]
      },
      "carrier2": {
        "weight_tiers": [
          2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30
        ],
        "weight_rates": [
          3.97, 3.97, 4.07, 4.11, 4.18, 4.32, 4.37, 4.4, 4.52, 4.92, 5.06, 5.11,
          5.12, 5.33, 5.75
        ]
      }
    },
    "distribution_center_2": {
      "carrier1": {
        "weight_tiers": [
          2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30
        ],
        "weight_rates": [
          3.73, 3.76, 3.77, 3.77, 3.8, 3.88, 3.96, 4.05, 4.09, 4.11, 4.34, 4.58,
          4.62, 4.68, 4.69
        ]
      },
      "carrier2": {
        "weight_tiers": [
          2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30
        ],
        "weight_rates": [
          3.97, 3.97, 4.07, 4.11, 4.18, 4.32, 4.37, 4.4, 4.52, 4.92, 5.06, 5.11,
          5.12, 5.33, 5.75
        ]
      }
    }
  },
  "carrier_dimensional_weight_factors": {
    "carrier1": 1.33,
    "carrier2": 1.43
  }
}

Output

The output schema defines the solution to the order fulfillment problem in JSON format. The output schema contains the following components.

Field name	Always present	Data type	SI Unit	Description	Example
`solutions`	Yes	`array` of `solution`	NA	Solutions to the order fulfillment problem.	`{"solutions": []}`
`statistics`	Yes	`statistics`	NA	Summary statistics of the solution.	`{"statistics": {"total_cost": 123}}`

Bash

{
  "options": {
    "solve": {
      "control": {
        "bool": [],
        "float": [],
        "int": [],
        "string": []
      },
      "duration": 3000000000,
      "mip": {
        "gap": {
          "absolute": 0.000001,
          "relative": 0.0001
        }
      },
      "verbosity": "off"
    }
  },
  "solutions": [
    {
      "assignments": [
        {
          "carrier_id": "carrier1",
          "distribution_center_id": "distribution_center_2",
          "item_id": "book",
          "quantity": 3
        },
        {
          "carrier_id": "carrier2",
          "distribution_center_id": "distribution_center_2",
          "item_id": "book",
          "quantity": 2
        },
        {
          "carrier_id": "carrier2",
          "distribution_center_id": "distribution_center_1",
          "item_id": "sneaker",
          "quantity": 1
        },
        {
          "carrier_id": "carrier2",
          "distribution_center_id": "distribution_center_2",
          "item_id": "sneaker",
          "quantity": 1
        },
        {
          "carrier_id": "carrier2",
          "distribution_center_id": "distribution_center_1",
          "item_id": "hydrating gel",
          "quantity": 3
        },
        {
          "carrier_id": "carrier1",
          "distribution_center_id": "distribution_center_2",
          "item_id": "hydrating gel",
          "quantity": 2
        },
        {
          "carrier_id": "carrier1",
          "distribution_center_id": "distribution_center_2",
          "item_id": "hydrating gel",
          "quantity": 3
        },
        {
          "carrier_id": "carrier1",
          "distribution_center_id": "distribution_center_2",
          "item_id": "hydrating gel",
          "quantity": 4
        },
        {
          "carrier_id": "carrier1",
          "distribution_center_id": "distribution_center_2",
          "item_id": "pressure cooker",
          "quantity": 1
        },
        {
          "carrier_id": "carrier2",
          "distribution_center_id": "distribution_center_2",
          "item_id": "pressure cooker",
          "quantity": 1
        },
        {
          "carrier_id": "carrier1",
          "distribution_center_id": "distribution_center_2",
          "item_id": "mattress",
          "quantity": 1
        },
        {
          "carrier_id": "carrier2",
          "distribution_center_id": "distribution_center_2",
          "item_id": "mattress",
          "quantity": 1
        }
      ],
      "billable_weights": {
        "distribution_center_1-carrier1": 2,
        "distribution_center_1-carrier2": 4,
        "distribution_center_2-carrier1": 10,
        "distribution_center_2-carrier2": 10
      },
      "cartons": {
        "distribution_center_1-carrier1": 0,
        "distribution_center_1-carrier2": 0.25,
        "distribution_center_2-carrier1": 2.3000000000000003,
        "distribution_center_2-carrier2": 1.9000000000000001
      },
      "delivery_costs": {
        "distribution_center_1-carrier1": 3.73,
        "distribution_center_1-carrier2": 3.97,
        "distribution_center_2-carrier1": 3.8000000000000003,
        "distribution_center_2-carrier2": 4.18
      },
      "dimensional_weights": {
        "distribution_center_1-carrier1": 0,
        "distribution_center_1-carrier2": 0.715,
        "distribution_center_2-carrier1": 6.118,
        "distribution_center_2-carrier2": 5.433999999999999
      },
      "status": "optimal",
      "value": 17.19,
      "volumes": {
        "distribution_center_1-carrier1": 0,
        "distribution_center_1-carrier2": 0.5,
        "distribution_center_2-carrier1": 4.6000000000000005,
        "distribution_center_2-carrier2": 3.8000000000000003
      },
      "weight_tiers": {
        "distribution_center_1-carrier1": {
          "0": 1,
          "1": 0,
          "10": 0,
          "11": 0,
          "12": 0,
          "13": 0,
          "14": 0,
          "15": 0,
          "2": 0,
          "3": 0,
          "4": 0,
          "5": 0,
          "6": 0,
          "7": 0,
          "8": 0,
          "9": 0
        },
        "distribution_center_1-carrier2": {
          "0": 0,
          "1": 1,
          "10": 0,
          "11": 0,
          "12": 0,
          "13": 0,
          "14": 0,
          "15": 0,
          "2": 0,
          "3": 0,
          "4": 0,
          "5": 0,
          "6": 0,
          "7": 0,
          "8": 0,
          "9": 0
        },
        "distribution_center_2-carrier1": {
          "0": 0,
          "1": 0,
          "10": 0,
          "11": 0,
          "12": 0,
          "13": 0,
          "14": 0,
          "15": 0,
          "2": 0,
          "3": 0,
          "4": 1,
          "5": 0,
          "6": 0,
          "7": 0,
          "8": 0,
          "9": 0
        },
        "distribution_center_2-carrier2": {
          "0": 0,
          "1": 0,
          "10": 0,
          "11": 0,
          "12": 0,
          "13": 0,
          "14": 0,
          "15": 0,
          "2": 0,
          "3": 0,
          "4": 1,
          "5": 0,
          "6": 0,
          "7": 0,
          "8": 0,
          "9": 0
        }
      },
      "weights": {
        "distribution_center_1-carrier1": 0,
        "distribution_center_1-carrier2": 0.8300000000000001,
        "distribution_center_2-carrier1": 9.89,
        "distribution_center_2-carrier2": 10
      }
    }
  ],
  "statistics": {
    "result": {
      "custom": {
        "delivery_costs": 15.68,
        "handling_costs": 1.51
      },
      "duration": 0.123,
      "value": 17.19
    },
    "run": {
      "duration": 0.123
    },
    "schema": "v1"
  },
  "version": {
    "go-highs": "VERSION",
    "go-mip": "VERSION",
    "sdk": "VERSION"
  }
}

Solution

Field name	Always present	Data type	SI Unit	Description	Example
`assignments`	Yes	`array` of `assignment`	NA	Solution to the order fulfillment problem	See `assignment`

Assignment

Field name	Always present	Data type	SI Unit	Description	Example
`item_id`	Yes	`string`	NA	ID of the item.	`{"item_id": "book"}`
`quantity`	Yes	`int`	NA	Quantity of the items in the assignment.	`{"quantity": 1}`
`distribution_center_id`	Yes	`string`	NA	ID of the distribution center.	`{"distribution_center_id": "distribution_center_2"}`
`carrier_id`	Yes	`string`	NA	ID of the carrier.	`{"carrier_id": "carrier1"}`

Statistics

Field name	Always present	Data type	SI Unit	Description	Example
`result`	No	`result`	NA	Final result of the solutions.	See `result`
`run`	Yes	`run`	NA	Information about the run.	See `run`
`schema`	Yes	`string`	NA	Schema of the statistics.	`{"schema": "v1"}`

Here you can find additional definitions used in the statistics schema:

result

Field name	Always present	Data type	SI Unit	Description	Example
`duration`	Yes	`float`	`seconds`	Time duration to get to the final result.	`{"duration": 0.123}`
`value`	Yes	`float`	NA	Value of the final result.	`{"value": 0.123}`
`custom`	Yes	`any`	NA	Custom solver metrics.	See `custom`

run
Field name Always present Data type SI Unit Description Example
duration Yes float seconds Time duration of the run. {"duration": 0.123}

Field name	Always present	Data type	SI Unit	Description	Example
`duration`	Yes	`float`	`seconds`	Time duration of the run.	`{"duration": 0.123}`

custom

Field name	Always present	Data type	SI Unit	Description	Example
`constraints`	Yes	`int`	NA	Number of constraints.	`{"constraints": 123}`
`provider`	Yes	`string`	NA	Solver provider.	`{"provider": "highs"}`
`status`	Yes	`string`	NA	Solver status.	`{"status": "optimal"}`
`variables`	Yes	`int`	NA	Number of variables.	`{"variables": 123}`

Run options

These are the default options that are available with routing without constraints.

Bash

Nextmv Hybrid Optimization Platform
Usage:
  -runner.input.path string
    	The input file path (env RUNNER_INPUT_PATH)
  -runner.output.path string
    	The output file path (env RUNNER_OUTPUT_PATH)
  -runner.output.solutions string
    	{all, last} (env RUNNER_OUTPUT_SOLUTIONS) (default "last")
  -runner.profile.cpu string
    	The CPU profile file path (env RUNNER_PROFILE_CPU)
  -runner.profile.memory string
    	The memory profile file path (env RUNNER_PROFILE_MEMORY)
  -solve.control.bool string
    	List of solver-specific control options (configurations) with bool values. Example: "name1=value1,name2=value2", where value1 and value2 are bool values. (env SOLVE_CONTROL_BOOL)
  -solve.control.float string
    	List of solver-specific control options (configurations) with float values. Example: "name1=value1,name2=value2", where value1 and value2 are float values. (env SOLVE_CONTROL_FLOAT)
  -solve.control.int string
    	List of solver-specific control options (configurations) with int values. Example: "name1=value1,name2=value2", where value1 and value2 are int values. (env SOLVE_CONTROL_INT)
  -solve.control.string string
    	List of solver-specific control options (configurations) with string values. Example: "name1=value1,name2=value2", where value1 and value2 are string values. (env SOLVE_CONTROL_STRING)
  -solve.duration duration
    	Maximum duration of the solver. (env SOLVE_DURATION) (default 30s)
  -solve.mip.gap.absolute float
    	Absolute gap stopping value. If the problem is an integer problem the solver will stop if the gap between the relaxed problem and the best found integer problem is less than this value. (env SOLVE_MIP_GAP_ABSOLUTE) (default 1e-06)
  -solve.mip.gap.relative float
    	Relative gap stopping value. If the problem is an integer problem the solver will stop if the relative gap between the relaxed problem and the best found integer problem is less than this value. (env SOLVE_MIP_GAP_RELATIVE) (default 0.0001)
  -solve.verbosity value
    	{off, low, medium, high} Verbosity of the solver in the console. (env SOLVE_VERBOSITY)

A how-to guide for specifying the input and output schemas in order fulfillment.