Create a New Allocation
POST /orders/{order_id}/allocations
POST
/orders/{order_id}/allocations
Parameters
Path Parameters
order_id
required
integer
Order ID
Example
323498
Header Parameters
x-api-key
string
E.g. 123
Example
123
Request Body
object
allocation
object
warehouse_id
required
Warehouse ID
number
5
line_items_attributes
required
Array
Example
{ "allocation": { "warehouse_id": 5, "line_items_attributes": [ { "sellable_id": 1226615, "quantity": 1 } ] }}
Responses
201
Created
object
allocated_completely
boolean
allocations
Array<object>
object
allocated_by
object
account_owner_user_id
activated_at
activation_code
api_key
string
company_id
number
created_at
string
created_by_id
default_till_id
deleted_at
deleted_by_id
email
string
guide_completed_message_viewed
guide_progress
id
number
location
login
string
orders_walkthrough_viewed
boolean
password_reset_token
state
string
updated_at
string
updated_by_id
created_at
string
id
number
line_items
Array<object>
object
created_at
string
id
number
quantity
number
sellable
object
active_channels
Array
allocated_stock_level_at_all_warehouses
number
available_stock_level_at_all_warehouses
number
channel_sellables
Array
cost_price
number
created_at
string
created_by_id
number
full_title
string
id
number
images
Array
inventory
object
allocated_stock_level_at_all_warehouses
number
available_stock_level_at_all_warehouses
number
incoming_stock_level_at_all_warehouses
number
infinite
boolean
physical_stock_level_at_all_warehouses
number
margin
number
measurement_attributes
object
depth
number
dimensions_unit
string
height
number
id
number
width
number
min_reorder_level
number
model_number
string
on_hand_value
number
price
number
product
object
description
string
estimated_delivery
hs_tariff_number
id
number
main_image
object
binary_data
content_type
created_at
string
created_by_id
deleted_at
deleted_by_id
display_position
id
number
picture_content_type
picture_file_name
picture_file_size
picture_order
number
picture_updated_at
product_id
number
src
string
updated_at
string
updated_by_id
main_image_src
string
origin_country
tax_rate
number
title
string
weight
number
product_title
string
profit
number
quantity_to_reorder
number
sellable_title
string
sku_code
string
stock_entries
Array<object>
object
allocated_stock_level
number
available_stock_level
number
incoming_stock_level
number
infinite
boolean
location
physical_stock_level
number
sellable_id
number
sellable_on_hand_value
number
stock_running_low
boolean
updated_at
string
warehouse
object
address_line_1
string
address_line_2
string
city
string
click_and_collect_days
click_and_collect_enabled
boolean
country
created_at
string
created_by_id
number
default_min_reorder
number
deleted_at
deleted_by_id
id
number
inventory_type_code
string
name
string
phone
post_code
string
region
string
requested_carrier_account
updated_at
string
updated_by_id
user_id
warehouse_id
number
stock_level_at_all_warehouses
number
tax_rate
number
title
string
total_quantity_sold
number
type
string
upc_code
string
updated_at
string
variant_option_specifics
Array
variant_property_specifics
Array
weight
number
updated_at
string
order_id
number
recommended_shipping_options
shipment
total_weight
number
updated_at
string
warehouse
object
address_line_1
string
address_line_2
string
city
string
click_and_collect_days
click_and_collect_enabled
boolean
country
created_at
string
created_by_id
number
default_min_reorder
number
deleted_at
deleted_by_id
id
number
inventory_type_code
string
name
string
phone
post_code
string
region
string
requested_carrier_account
updated_at
string
updated_by_id
user_id
buyer_user_id
cancel_reason
cancelled_at
cancelled_by
channel
object
active_warehouses
Array<object>
object
id
number
name
string
address_line_1
string
address_line_2
string
api2cart_store_key
automatic_product_linking_disabled
boolean
bridge_url
bridge_verified
boolean
channel_warehouses
Array<object>
object
rank
number
warehouse
object
address_line_1
string
address_line_2
string
city
string
click_and_collect_days
click_and_collect_enabled
boolean
country
created_at
string
created_by_id
number
default_min_reorder
number
deleted_at
deleted_by_id
id
number
inventory_type_code
string
name
string
phone
post_code
string
region
string
requested_carrier_account
updated_at
string
updated_by_id
user_id
city
string
country
create_product_if_unmatched
boolean
created_by_id
number
default_send_shipment_email
boolean
default_warehouse
object
address_line_1
string
address_line_2
string
city
string
click_and_collect_days
click_and_collect_enabled
boolean
country
created_at
string
created_by_id
number
default_min_reorder
number
deleted_at
deleted_by_id
id
number
inventory_type_code
string
name
string
phone
post_code
string
region
string
requested_carrier_account
updated_at
string
updated_by_id
user_id
deleted_at
deleted_by_id
email
string
id
number
marketplace_id
mws_auth_token
name
string
pending_setup
boolean
post_code
string
pull_pending_orders
boolean
pulled_orders_at
pulled_products_at
region
string
remote
boolean
seller_id
shopify_url
skip_title_matching
boolean
state
string
stock_level_update_requests
Array
successfully_fetched_stock_levels_at
type_code
string
update_remote_order
boolean
url
created_at
string
created_by
object
company
object
billing_period_started
card_valid
boolean
created_at
string
has_right_to_use_veeqo
boolean
id
number
name
string
referring_website
string
stripe_customer_id
subscription_plan
object
billing_interval
string
id
number
name
string
stripe_plan_id
string
subscription_plan_id
number
subscription_status
string
updated_at
string
created_at
string
email
string
guide_completed_message_viewed
id
number
location
login
string
orders_walkthrough_viewed
boolean
updated_at
string
customer
object
billing_address
object
address1
string
address2
city
string
company
country
string
email
first_name
string
id
number
last_name
string
phone
string
state
string
zip
string
created_by_id
number
email
string
id
number
mobile
phone
string
shipping_addresses
Array<object>
object
address1
required
string
address2
required
string
city
required
string
company
required
string
country
required
string
first_name
required
string
id
required
number
last_name
required
string
phone
required
string
state
required
string
zip
required
string
customer_note
customer_viewable_notes
deliver_to
object
address1
string
address2
string
city
string
company
string
country
string
first_name
string
id
number
last_name
string
phone
string
state
string
zip
string
delivery_cost
number
delivery_method
object
cost
number
id
number
name
string
user_id
number
due_date
employee_notes
Array
fulfilled_by_amazon
boolean
id
number
international
boolean
line_items
Array<object>
object
additional_options
created_at
string
id
number
price_per_unit
number
quantity
number
sellable
object
active_channels
Array
allocated_stock_level_at_all_warehouses
number
available_stock_level_at_all_warehouses
number
channel_sellables
Array
cost_price
number
created_at
string
created_by_id
number
full_title
string
id
number
images
Array
inventory
object
allocated_stock_level_at_all_warehouses
number
available_stock_level_at_all_warehouses
number
incoming_stock_level_at_all_warehouses
number
infinite
boolean
physical_stock_level_at_all_warehouses
number
margin
number
measurement_attributes
object
depth
number
dimensions_unit
string
height
number
id
number
width
number
min_reorder_level
number
model_number
string
on_hand_value
number
price
number
product
object
description
string
estimated_delivery
hs_tariff_number
id
number
main_image
object
binary_data
content_type
created_at
string
created_by_id
deleted_at
deleted_by_id
display_position
id
number
picture_content_type
picture_file_name
picture_file_size
picture_order
number
picture_updated_at
product_id
number
src
string
updated_at
string
updated_by_id
main_image_src
string
origin_country
tax_rate
number
title
string
weight
number
product_title
string
profit
number
quantity_to_reorder
number
sellable_title
string
sku_code
string
stock_entries
Array<object>
object
allocated_stock_level
number
available_stock_level
number
incoming_stock_level
number
infinite
boolean
location
physical_stock_level
number
sellable_id
number
sellable_on_hand_value
number
stock_running_low
boolean
updated_at
string
warehouse
object
address_line_1
string
address_line_2
string
city
string
click_and_collect_days
click_and_collect_enabled
boolean
country
created_at
string
created_by_id
number
default_min_reorder
number
deleted_at
deleted_by_id
id
number
inventory_type_code
string
name
string
phone
post_code
string
region
string
requested_carrier_account
updated_at
string
updated_by_id
user_id
warehouse_id
number
stock_level_at_all_warehouses
number
tax_rate
number
title
string
total_quantity_sold
number
type
string
upc_code
string
updated_at
string
variant_option_specifics
Array
variant_property_specifics
Array
weight
number
tax_rate
number
updated_at
string
notes
number
string
packed_completely
payment
object
card_number
created_at
string
created_by_id
number
id
number
order_id
number
payment_type
string
reference_number
string
updated_at
string
picked_completely
receipt_printed
boolean
refund_amount
returns
Array
send_notification_email
boolean
send_refund_email
shipped_at
status
string
subtotal_price
number
tags
Array
till_id
total_discounts
number
total_price
number
total_tax
number
updated_at
string
updated_by
Example
{ "allocated_completely": true, "allocations": [ { "allocated_by": { "account_owner_user_id": null, "activated_at": null, "activation_code": null, "api_key": "b2d62a6d9dd6c5fff4b2d125214b088f", "company_id": 1717, "created_at": "2016-03-21T11:42:55Z", "created_by_id": null, "default_till_id": null, "deleted_at": null, "deleted_by_id": null, "email": "dev01@bdhr.co", "guide_completed_message_viewed": null, "guide_progress": null, "id": 1923, "location": null, "login": "Dev01", "orders_walkthrough_viewed": false, "password_reset_token": null, "state": "passive", "updated_at": "2016-04-01T09:46:12Z", "updated_by_id": null }, "created_at": "2016-04-06T12:25:40Z", "id": 323498, "line_items": [ { "created_at": "2016-04-06T12:25:40Z", "id": 486254, "quantity": 1, "sellable": { "active_channels": [], "allocated_stock_level_at_all_warehouses": 2, "available_stock_level_at_all_warehouses": 4, "channel_sellables": [], "cost_price": 0, "created_at": "2016-03-21T11:42:56Z", "created_by_id": 1923, "full_title": "MEN'S SUPERMAN SHORT SLEEVE T-SHIRT [TEST] MEDIUM", "id": 1226615, "images": [], "inventory": { "allocated_stock_level_at_all_warehouses": 2, "available_stock_level_at_all_warehouses": 4, "incoming_stock_level_at_all_warehouses": 0, "infinite": false, "physical_stock_level_at_all_warehouses": 6 }, "margin": 100, "measurement_attributes": { "depth": 0, "dimensions_unit": "cm", "height": 0, "id": 622133, "width": 0 }, "min_reorder_level": 0, "model_number": "", "on_hand_value": 0, "price": 13.99, "product": { "description": "", "estimated_delivery": null, "hs_tariff_number": null, "id": 574313, "main_image": { "binary_data": null, "content_type": null, "created_at": "2016-03-21T11:42:56Z", "created_by_id": null, "deleted_at": null, "deleted_by_id": null, "display_position": null, "id": 795405, "picture_content_type": null, "picture_file_name": null, "picture_file_size": null, "picture_order": 9999, "picture_updated_at": null, "product_id": 574313, "src": "https://veeqo-production-storage.s3.amazonaws.com/images/2032154/fs004027-new_original.jpg", "updated_at": "2016-03-21T11:42:56Z", "updated_by_id": null }, "main_image_src": "https://veeqo-production-storage.s3.amazonaws.com/images/2032154/fs004027-new_original.jpg", "origin_country": null, "tax_rate": 0, "title": "MEN'S SUPERMAN SHORT SLEEVE T-SHIRT [TEST]", "weight": 0 }, "product_title": "MEN'S SUPERMAN SHORT SLEEVE T-SHIRT [TEST]", "profit": 13.99, "quantity_to_reorder": 0, "sellable_title": "MEDIUM", "sku_code": "SUP-007", "stock_entries": [ { "allocated_stock_level": 2, "available_stock_level": 4, "incoming_stock_level": 0, "infinite": false, "location": null, "physical_stock_level": 6, "sellable_id": 1226615, "sellable_on_hand_value": 0, "stock_running_low": false, "updated_at": "2016-04-06T12:25:40Z", "warehouse": { "address_line_1": "", "address_line_2": "", "city": "", "click_and_collect_days": null, "click_and_collect_enabled": false, "country": null, "created_at": "2016-03-21T11:42:55Z", "created_by_id": 1923, "default_min_reorder": 0, "deleted_at": null, "deleted_by_id": null, "id": 1784, "inventory_type_code": "wavg", "name": "My Warehouse", "phone": null, "post_code": "", "region": "", "requested_carrier_account": null, "updated_at": "2016-03-21T11:42:55Z", "updated_by_id": null, "user_id": null }, "warehouse_id": 1784 } ], "stock_level_at_all_warehouses": 6, "tax_rate": 0, "title": "MEDIUM", "total_quantity_sold": 2, "type": "ProductVariant", "upc_code": "", "updated_at": "2016-03-21T11:42:56Z", "variant_option_specifics": [], "variant_property_specifics": [], "weight": 0 }, "updated_at": "2016-04-06T12:25:40Z" } ], "order_id": 447452, "recommended_shipping_options": null, "shipment": null, "total_weight": 0, "updated_at": "2016-04-06T12:25:40Z", "warehouse": { "address_line_1": "", "address_line_2": "", "city": "", "click_and_collect_days": null, "click_and_collect_enabled": false, "country": null, "created_at": "2016-03-21T11:42:55Z", "created_by_id": 1923, "default_min_reorder": 0, "deleted_at": null, "deleted_by_id": null, "id": 1784, "inventory_type_code": "wavg", "name": "My Warehouse", "phone": null, "post_code": "", "region": "", "requested_carrier_account": null, "updated_at": "2016-03-21T11:42:55Z", "updated_by_id": null, "user_id": null } } ], "buyer_user_id": null, "cancel_reason": null, "cancelled_at": null, "cancelled_by": null, "channel": { "active_warehouses": [ { "id": 1784, "name": "My Warehouse" } ], "address_line_1": "", "address_line_2": "", "api2cart_store_key": null, "automatic_product_linking_disabled": false, "bridge_url": null, "bridge_verified": false, "channel_warehouses": [ { "rank": 1, "warehouse": { "address_line_1": "", "address_line_2": "", "city": "", "click_and_collect_days": null, "click_and_collect_enabled": false, "country": null, "created_at": "2016-03-21T11:42:55Z", "created_by_id": 1923, "default_min_reorder": 0, "deleted_at": null, "deleted_by_id": null, "id": 1784, "inventory_type_code": "wavg", "name": "My Warehouse", "phone": null, "post_code": "", "region": "", "requested_carrier_account": null, "updated_at": "2016-03-21T11:42:55Z", "updated_by_id": null, "user_id": null } } ], "city": "", "country": null, "create_product_if_unmatched": true, "created_by_id": 1923, "default_send_shipment_email": true, "default_warehouse": { "address_line_1": "", "address_line_2": "", "city": "", "click_and_collect_days": null, "click_and_collect_enabled": false, "country": null, "created_at": "2016-03-21T11:42:55Z", "created_by_id": 1923, "default_min_reorder": 0, "deleted_at": null, "deleted_by_id": null, "id": 1784, "inventory_type_code": "wavg", "name": "My Warehouse", "phone": null, "post_code": "", "region": "", "requested_carrier_account": null, "updated_at": "2016-03-21T11:42:55Z", "updated_by_id": null, "user_id": null }, "deleted_at": null, "deleted_by_id": null, "email": "dev01@bdhr.co", "id": 3525, "marketplace_id": null, "mws_auth_token": null, "name": "Phone", "pending_setup": true, "post_code": "", "pull_pending_orders": false, "pulled_orders_at": null, "pulled_products_at": null, "region": "", "remote": false, "seller_id": null, "shopify_url": null, "skip_title_matching": true, "state": "active", "stock_level_update_requests": [], "successfully_fetched_stock_levels_at": null, "type_code": "direct", "update_remote_order": true, "url": null }, "created_at": "2016-04-06T12:25:40Z", "created_by": { "company": { "billing_period_started": null, "card_valid": false, "created_at": "2016-03-21T11:42:55Z", "has_right_to_use_veeqo": true, "id": 1717, "name": "Dev01", "referring_website": "", "stripe_customer_id": null, "subscription_plan": { "billing_interval": "month", "id": 62, "name": "Business[Monthly]", "stripe_plan_id": "BUSINESS_MONTHLY_20160309" }, "subscription_plan_id": 62, "subscription_status": "trialing", "updated_at": "2016-03-21T11:42:55Z" }, "created_at": "2016-03-21T11:42:55Z", "email": "dev01@bdhr.co", "guide_completed_message_viewed": null, "id": 1923, "location": null, "login": "Dev01", "orders_walkthrough_viewed": false, "updated_at": "2016-04-01T09:46:12Z" }, "customer": { "billing_address": { "address1": "294 queenstown road", "address2": null, "city": "london", "company": null, "country": "GB", "email": null, "first_name": "Sky", "id": 1086864, "last_name": "Schonhuber", "phone": "07734450718", "state": "london", "zip": "sw8 4lt" }, "created_by_id": 1923, "email": "customer@example.com", "id": 516208, "mobile": null, "phone": "0207376109", "shipping_addresses": [ { "address1": "294 queenstown road", "address2": null, "city": "london", "company": null, "country": "GB", "first_name": "Sky", "id": 1086865, "last_name": "Schonhuber", "phone": "07734450718", "state": "london", "zip": "sw8 4lt" }, { "address1": "294 queenstown road", "address2": "", "city": "london", "company": "", "country": "GB", "first_name": "Sky", "id": 1086866, "last_name": "Schonhuber", "phone": "07734450718", "state": "london", "zip": "sw8 4lt" }, { "address1": "294 queenstown road", "address2": "", "city": "london", "company": "", "country": "GB", "first_name": "Sky", "id": 1086867, "last_name": "Schonhuber", "phone": "07734450718", "state": "london", "zip": "sw8 4lt" } ] }, "customer_note": null, "customer_viewable_notes": null, "deliver_to": { "address1": "294 queenstown road", "address2": "", "city": "london", "company": "", "country": "GB", "first_name": "Sky", "id": 1086867, "last_name": "Schonhuber", "phone": "07734450718", "state": "london", "zip": "sw8 4lt" }, "delivery_cost": 0, "delivery_method": { "cost": 0, "id": 92298, "name": "Default delivery method", "user_id": 1923 }, "due_date": null, "employee_notes": [], "fulfilled_by_amazon": false, "id": 447452, "international": false, "line_items": [ { "additional_options": null, "created_at": "2016-04-06T12:25:40Z", "id": 691572, "price_per_unit": 13.99, "quantity": 1, "sellable": { "active_channels": [], "allocated_stock_level_at_all_warehouses": 2, "available_stock_level_at_all_warehouses": 4, "channel_sellables": [], "cost_price": 0, "created_at": "2016-03-21T11:42:56Z", "created_by_id": 1923, "full_title": "MEN'S SUPERMAN SHORT SLEEVE T-SHIRT [TEST] MEDIUM", "id": 1226615, "images": [], "inventory": { "allocated_stock_level_at_all_warehouses": 2, "available_stock_level_at_all_warehouses": 4, "incoming_stock_level_at_all_warehouses": 0, "infinite": false, "physical_stock_level_at_all_warehouses": 6 }, "margin": 100, "measurement_attributes": { "depth": 0, "dimensions_unit": "cm", "height": 0, "id": 622133, "width": 0 }, "min_reorder_level": 0, "model_number": "", "on_hand_value": 0, "price": 13.99, "product": { "description": "", "estimated_delivery": null, "hs_tariff_number": null, "id": 574313, "main_image": { "binary_data": null, "content_type": null, "created_at": "2016-03-21T11:42:56Z", "created_by_id": null, "deleted_at": null, "deleted_by_id": null, "display_position": null, "id": 795405, "picture_content_type": null, "picture_file_name": null, "picture_file_size": null, "picture_order": 9999, "picture_updated_at": null, "product_id": 574313, "src": "https://veeqo-production-storage.s3.amazonaws.com/images/2032154/fs004027-new_original.jpg", "updated_at": "2016-03-21T11:42:56Z", "updated_by_id": null }, "main_image_src": "https://veeqo-production-storage.s3.amazonaws.com/images/2032154/fs004027-new_original.jpg", "origin_country": null, "tax_rate": 0, "title": "MEN'S SUPERMAN SHORT SLEEVE T-SHIRT [TEST]", "weight": 0 }, "product_title": "MEN'S SUPERMAN SHORT SLEEVE T-SHIRT [TEST]", "profit": 13.99, "quantity_to_reorder": 0, "sellable_title": "MEDIUM", "sku_code": "SUP-007", "stock_entries": [ { "allocated_stock_level": 2, "available_stock_level": 4, "incoming_stock_level": 0, "infinite": false, "location": null, "physical_stock_level": 6, "sellable_id": 1226615, "sellable_on_hand_value": 0, "stock_running_low": false, "updated_at": "2016-04-06T12:25:40Z", "warehouse": { "address_line_1": "", "address_line_2": "", "city": "", "click_and_collect_days": null, "click_and_collect_enabled": false, "country": null, "created_at": "2016-03-21T11:42:55Z", "created_by_id": 1923, "default_min_reorder": 0, "deleted_at": null, "deleted_by_id": null, "id": 1784, "inventory_type_code": "wavg", "name": "My Warehouse", "phone": null, "post_code": "", "region": "", "requested_carrier_account": null, "updated_at": "2016-03-21T11:42:55Z", "updated_by_id": null, "user_id": null }, "warehouse_id": 1784 } ], "stock_level_at_all_warehouses": 6, "tax_rate": 0, "title": "MEDIUM", "total_quantity_sold": 2, "type": "ProductVariant", "upc_code": "", "updated_at": "2016-03-21T11:42:56Z", "variant_option_specifics": [], "variant_property_specifics": [], "weight": 0 }, "tax_rate": 0, "updated_at": "2016-04-06T12:25:40Z" } ], "notes": null, "number": "#P-447452", "packed_completely": null, "payment": { "card_number": null, "created_at": "2016-04-06T12:25:40Z", "created_by_id": 1923, "id": 415007, "order_id": 447452, "payment_type": "bank_transfer", "reference_number": "123456789", "updated_at": "2016-04-06T12:25:40Z" }, "picked_completely": null, "receipt_printed": false, "refund_amount": null, "returns": [], "send_notification_email": false, "send_refund_email": null, "shipped_at": null, "status": "awaiting_fulfillment", "subtotal_price": 13.99, "tags": [], "till_id": null, "total_discounts": 0, "total_price": 13.99, "total_tax": 0, "updated_at": "2016-04-06T12:25:40Z", "updated_by": null}
Headers
Location
string