Download OpenAPI specification:Download
| message_datetime | string (Message Datetime) Optional: This datetime will be automatically filled but can also be given as input. When given as input it will remain unaltered. |
| correlation_id | string (Correlation Id) <= 10000 characters Optional: Identifier that will be returned when requesting the solution. This can make data management easier. This is a string field so a |
object (Hook Url Config) Optional: The results for this API requests can be fetched after they are available. Alternatively, a web hook can be provided here. When the request has been fully processed, the result will be sent to this hook address in an http POST request with the result in the body of the request in JSON format. The same result can still be fetched using the | |
| hook_email | string (Hook Email) Optional: The results for this API requests can be fetched after they are available. Alternatively, an email hook can be provided here. When the request has been fully processed, the result will be sent to this email address in the form of a .csv file The same result can still be fetched using the |
| customer_site required | string (Customer Site) Required: Your location site name |
| enforce_static_cart_pathing | boolean (Enforce Static Cart Pathing) Default: false Optional: The Pick Optimizer has the ability to make sure that all items that are assigned to the same cart will be picked in a certain order. This is called |
object (Sla Management Config) Optional: A request can contain orders with higher priority than others and sometimes these orders need a guarantee to be processed before others. This field tells the Optimizer how to enforce priority. The first field here is the | |
object (Product To Location Mapping) Optional: The | |
required | Array of objects (Order Items) Expand for more info. Required: A list of type |
{- "message_datetime": "string",
- "correlation_id": "string",
- "hook_url_config": {
- "hook_url": "string",
- "hook_headers_dict": { },
- "hook_params_dict": { }
}, - "hook_email": "string",
- "customer_site": "Warehouse1",
- "enforce_static_cart_pathing": false,
- "sla_management_config": {
- "order_line_processing_capacity": 100000,
- "priority_definitions": [
- {
- "priority_group": 0,
- "priority_group_percentage_requirement": 90
}, - {
- "priority_group": 1,
- "priority_group_percentage_requirement": 20
}
]
}, - "product_to_location_mapping": {
- "property1": [
- {
- "inventory_location_id": "string",
- "num_units_available": 0,
- "inventory_location_pick_sequence_id": 0,
- "inventory_location_height": 0,
- "inventory_license_plate_id": "string"
}
], - "property2": [
- {
- "inventory_location_id": "string",
- "num_units_available": 0,
- "inventory_location_pick_sequence_id": 0,
- "inventory_location_height": 0,
- "inventory_license_plate_id": "string"
}
]
}, - "order_items": [
- {
- "reference_id": "0",
- "wave_id": "WAVE_A31239",
- "order_id": "29401782",
- "product_id": "29401782",
- "pick_sequence_id": 0,
- "pick_location_id": "string",
- "valid_location": true,
- "splittable_from_order": false,
- "planned_pick_quantity": 1,
- "priority_group": 0,
- "product_x_dimension": 2.2,
- "product_y_dimension": 2.3,
- "product_z_dimension": 5.8,
- "pick_location_height": 0,
- "pick_to_shipper_box_options": [
- "string"
], - "shipper_name": "TomFooleryClothing",
- "scheduled_ship_datetime": "2023-09-15T20:40:38Z",
- "order_line_number": "string",
- "product_description": "XL T-Shirt",
- "product_family": "T-Shirt",
- "product_dimension_uom": "in"
}
]
}{- "job_id": "string"
}| job_id required | string (Job Id) Required: the |
{- "job_id": "string"
}null