Skip to content

Update Allocation Detail

PUT
/orders/{order_id}/allocations/{allocation_id}

Parameters

Path Parameters

order_id
required
integer

ID of the Order

allocation_id
required
integer

ID of the Allocation

Request Body

object
warehouse_id
number
line_items_attributes
Array<object>
object
sellable_id
number
quantity
number
Example
{
"warehouse_id": 5,
"line_items_attributes": [
{
"sellable_id": 1226615,
"quantity": 2
}
]
}

Responses

200

OK

object
id
number
updated_at
string
created_at
string
total_weight
number
weight_unit
string
allocated_by_id
number
order_id
number
packed_completely
nullable
line_items
Array<object>
object
id
required
number
quantity
required
number
picked_quantity
required
number
created_at
required
string
updated_at
required
string
sellable
required
object
total_quantity_sold
number
allocated_stock_level_at_all_warehouses
number
id
number
type
string
title
string
sku_code
string
upc_code
string
model_number
string
price
number
cost_price
number
min_reorder_level
number
quantity_to_reorder
number
created_by_id
number
created_at
string
updated_at
string
weight_grams
number
weight_unit
string
product_title
string
full_title
string
sellable_title
string
profit
number
margin
number
tax_rate
number
product
object
id
number
title
string
weight
number
origin_country
nullable
hs_tariff_number
nullable
tax_rate
number
main_image
nullable
estimated_delivery
nullable
deleted_at
nullable
deleted_by_id
nullable
description
string
main_image_src
nullable
stock_entries
Array<object>
object
sellable_id
required
number
warehouse_id
required
number
infinite
required
boolean
allocated_stock_level
required
number
warehouse
required
object
id
number
name
string
user_id
nullable
address_line_1
string
address_line_2
string
city
string
region
string
country
nullable
post_code
string
inventory_type_code
string
default_min_reorder
number
click_and_collect_enabled
boolean
click_and_collect_days
nullable
created_by_id
number
updated_by_id
nullable
deleted_at
nullable
deleted_by_id
nullable
created_at
string
updated_at
string
phone
nullable
requested_carrier_account
nullable
location
required
string
stock_running_low
required
boolean
updated_at
required
string
incoming_stock_level
required
number
physical_stock_level
required
number
available_stock_level
required
number
sellable_on_hand_value
required
number
variant_option_specifics
Array
variant_property_specifics
Array
measurement_attributes
object
id
number
width
number
height
number
depth
number
dimensions_unit
string
images
Array
active_channels
Array
channel_sellables
Array
available_stock_level_at_all_warehouses
number
stock_level_at_all_warehouses
number
on_hand_value
number
inventory
object
infinite
boolean
physical_stock_level_at_all_warehouses
number
allocated_stock_level_at_all_warehouses
number
available_stock_level_at_all_warehouses
number
incoming_stock_level_at_all_warehouses
number
weight
number
recommended_shipping_options
nullable
matched_parcel_properties_criteria
nullable
shipment
nullable
warehouse
object
address_line_1
string
address_line_2
string
city
string
click_and_collect_days
nullable
click_and_collect_enabled
boolean
country
nullable
created_at
string
created_by_id
number
default_min_reorder
number
deleted_at
nullable
deleted_by_id
nullable
id
number
inventory_type_code
string
name
string
phone
nullable
post_code
string
region
string
updated_at
string
updated_by_id
nullable
requested_carrier_account
nullable
Example
{
"id": 8741741,
"updated_at": "2017-10-19T10:33:55.449Z",
"created_at": "2017-10-19T10:33:55.234Z",
"total_weight": 100,
"weight_unit": "g",
"allocated_by_id": 23005,
"order_id": 11665111,
"packed_completely": null,
"line_items": [
{
"id": 11690886,
"quantity": 1,
"picked_quantity": 0,
"created_at": "2017-10-19T10:33:55.248Z",
"updated_at": "2017-10-19T10:33:55.248Z",
"sellable": {
"total_quantity_sold": 2,
"allocated_stock_level_at_all_warehouses": 1,
"id": 14504036,
"type": "ProductVariant",
"title": "Bobble",
"sku_code": "b-hat-1",
"upc_code": "",
"model_number": "",
"price": 1,
"cost_price": 2,
"min_reorder_level": 0,
"quantity_to_reorder": 0,
"created_by_id": 23005,
"created_at": "2017-10-18T08:29:35.915Z",
"updated_at": "2017-10-19T10:33:55.435Z",
"weight_grams": 100,
"weight_unit": "g",
"product_title": "Bobble Hat - Title",
"full_title": "Bobble Hat - Title Bobble",
"sellable_title": "Bobble",
"profit": -1,
"margin": -100,
"tax_rate": 0,
"product": {
"id": 8996243,
"title": "Bobble Hat - Title",
"weight": 0,
"origin_country": null,
"hs_tariff_number": null,
"tax_rate": 0,
"main_image": null,
"estimated_delivery": null,
"deleted_at": null,
"deleted_by_id": null,
"description": "Bobble Hat - Description",
"main_image_src": null
},
"stock_entries": [
{
"sellable_id": 14504036,
"warehouse_id": 22668,
"infinite": false,
"allocated_stock_level": 1,
"warehouse": {
"id": 22668,
"name": "My Warehouse",
"user_id": null,
"address_line_1": "",
"address_line_2": "",
"city": "",
"region": "",
"country": null,
"post_code": "",
"inventory_type_code": "wavg",
"default_min_reorder": 0,
"click_and_collect_enabled": false,
"click_and_collect_days": null,
"created_by_id": 23005,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null,
"created_at": "2017-07-04T09:40:37.539Z",
"updated_at": "2017-07-04T09:40:37.539Z",
"phone": null,
"requested_carrier_account": null
},
"location": "Hat Rack",
"stock_running_low": false,
"updated_at": "2017-10-19T10:33:55.258Z",
"incoming_stock_level": 0,
"physical_stock_level": 200,
"available_stock_level": 199,
"sellable_on_hand_value": 400
}
],
"variant_option_specifics": [],
"variant_property_specifics": [],
"measurement_attributes": {
"id": 12957733,
"width": 0,
"height": 0,
"depth": 0,
"dimensions_unit": "cm"
},
"images": [],
"active_channels": [],
"channel_sellables": [],
"available_stock_level_at_all_warehouses": 199,
"stock_level_at_all_warehouses": 200,
"on_hand_value": 400,
"inventory": {
"infinite": false,
"physical_stock_level_at_all_warehouses": 200,
"allocated_stock_level_at_all_warehouses": 1,
"available_stock_level_at_all_warehouses": 199,
"incoming_stock_level_at_all_warehouses": 0
},
"weight": 100
}
},
{
"id": 11690887,
"quantity": 1,
"picked_quantity": 0,
"created_at": "2017-10-19T10:33:55.334Z",
"updated_at": "2017-10-19T10:33:55.334Z",
"sellable": {
"total_quantity_sold": 1,
"allocated_stock_level_at_all_warehouses": 1,
"id": 14358568,
"type": "ProductVariant",
"title": "Puppy - ProdVariantTitle",
"sku_code": "g-dog-2",
"upc_code": "",
"model_number": "",
"price": 150,
"cost_price": 100,
"min_reorder_level": 0,
"quantity_to_reorder": 0,
"created_by_id": 23005,
"created_at": "2017-10-16T15:26:15.810Z",
"updated_at": "2017-10-19T10:33:55.459Z",
"weight_grams": 0,
"weight_unit": "g",
"product_title": "Golden Retriever Dog - Title",
"full_title": "Golden Retriever Dog - Title Puppy - ProdVariantTitle",
"sellable_title": "Puppy - ProdVariantTitle",
"profit": 50,
"margin": 33.33,
"tax_rate": 0,
"product": {
"id": 8851441,
"title": "Golden Retriever Dog - Title",
"weight": 0,
"origin_country": null,
"hs_tariff_number": null,
"tax_rate": 0,
"main_image": null,
"estimated_delivery": null,
"deleted_at": null,
"deleted_by_id": null,
"description": "Golden Retriever Dog - Description",
"main_image_src": null
},
"stock_entries": [
{
"sellable_id": 14358568,
"warehouse_id": 22668,
"infinite": false,
"allocated_stock_level": 1,
"warehouse": {
"id": 22668,
"name": "My Warehouse",
"user_id": null,
"address_line_1": "",
"address_line_2": "",
"city": "",
"region": "",
"country": null,
"post_code": "",
"inventory_type_code": "wavg",
"default_min_reorder": 0,
"click_and_collect_enabled": false,
"click_and_collect_days": null,
"created_by_id": 23005,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null,
"created_at": "2017-07-04T09:40:37.539Z",
"updated_at": "2017-07-04T09:40:37.539Z",
"phone": null,
"requested_carrier_account": null
},
"location": "Kennels",
"stock_running_low": false,
"updated_at": "2017-10-19T10:33:55.341Z",
"incoming_stock_level": 0,
"physical_stock_level": 10,
"available_stock_level": 9,
"sellable_on_hand_value": 1000
}
],
"variant_option_specifics": [],
"variant_property_specifics": [],
"measurement_attributes": {
"id": 12810244,
"width": 0,
"height": 0,
"depth": 0,
"dimensions_unit": "cm"
},
"images": [],
"active_channels": [],
"channel_sellables": [],
"available_stock_level_at_all_warehouses": 9,
"stock_level_at_all_warehouses": 10,
"on_hand_value": 1000,
"inventory": {
"infinite": false,
"physical_stock_level_at_all_warehouses": 10,
"allocated_stock_level_at_all_warehouses": 1,
"available_stock_level_at_all_warehouses": 9,
"incoming_stock_level_at_all_warehouses": 0
},
"weight": 0
}
}
],
"recommended_shipping_options": null,
"matched_parcel_properties_criteria": null,
"shipment": null,
"warehouse": {
"address_line_1": "",
"address_line_2": "",
"city": "",
"click_and_collect_days": null,
"click_and_collect_enabled": false,
"country": null,
"created_at": "2017-07-04T09:40:37.539Z",
"created_by_id": 23005,
"default_min_reorder": 0,
"deleted_at": null,
"deleted_by_id": null,
"id": 22668,
"inventory_type_code": "wavg",
"name": "My Warehouse",
"phone": null,
"post_code": "",
"region": "",
"updated_at": "2017-07-04T09:40:37.539Z",
"updated_by_id": null,
"requested_carrier_account": null
}
}