Create a New Order

POST

/orders

Parameters

Header Parameters

x-api-key

string

E.g. 123

Example

123

Request Body

object

order

Note: required IDs must be fetched before the order is created.

object

channel_id

required

Store ID - See Stores Resource

number

3525

customer_id

required

Optional if customer_attributes are included. (See Examples Below)

Customer ID - See Customers Resource

number

123456

deliver_to_id

required

Optional if deliver_to_attributes are included.

Customer’s Shipping Address ID - See Customers Resource

number

1086864

delivery_method_id

required

Delivery Method ID - See Delivery Methods Resource

number

92298

due_date

Expected delivery date, appears in the order interface

string

02/03/2017

number

External order number

string

123456abc

send_notification_email

Send order confirmation email

boolean

true

total_discounts

Total discounts price for the overall order

number

deliver_to_attributes

Delivery Address Attributes. Optional if deliver_to_id is included.

object

address1

Address line 1

string

294 Queenstown Road

address2

Address line 2

string

Borough

city

City

string

London

company

Company

string

Fashion Co

country

Country (ISO-2 code)

string

GB

customer_id

required

Customer’s ID - See Customers Resource

number

516208

first_name

First name

string

Sky

last_name

Last name

string

Schonhuber

phone

Phone number

string

07734450718

state

State

string

London

zip

ZIP code

string

S8 4LT

line_items_attributes

required

Line item attributes for the line items of the order

Array

payment_attributes

Payment attributes, if the order has a payment

object

payment_type

required

Type of payment - required if payment_attributes are included.

List of accepted payment types (variable_name: Display Name)

• none: “None”

• cash: “Cash”

• credit_card: “Credit Card”

• bank_transfer: “Bank Transfer”

• paypal: “Paypal”

• paypal_express: “Paypal Express”

• sagepay: “Sagepay”

• checkmo: “Check/Money order”

• online_finance: “Online Finance”

string

cash

reference_number

A reference string to refer to that payment

string

123456789

customer_note_attributes

Notes from customer

object

text

Text for the note

string

Ring the doorbell the leave in secure location

employee_note_attributes

Notes from employee

Array

Examples

{
  "order": {
    "channel_id": 45465,
    "customer_id": 12137952,
    "deliver_to_id": 26465395,
    "due_date": "31/01/2018",
    "number": "rdr1236",
    "send_notification_email": true,
    "line_items_attributes": [
      {
        "price_per_unit": "75.000",
        "taxless_discount_per_unit": "0.00",
        "quantity": "1",
        "tax_rate": 0.2,
        "sellable_id": 13847534,
        "additional_options": "This thing is a thing"
      },
      {
        "price_per_unit": "150.000",
        "taxless_discount_per_unit": "30.00",
        "quantity": "1",
        "tax_rate": 0.2,
        "sellable_id": 14358568,
        "additional_options": "This thing is also a thing"
      }
    ],
    "additional_order_level_taxless_discount": "19.50",
    "delivery_method_id": 171784,
    "delivery_cost": "2.00",
    "total_tax": "35.54",
    "total_discounts": "49.5",
    "payment_attributes": {
      "payment_type": "paypal",
      "reference_number": "PPP1234"
    },
    "customer_note_attributes": {
      "text": "Please tell Sam to look after this puppy. --This is a customer note--"
    },
    "employee_notes_attributes": [
      {
        "text": "Package contains a dog. Use suitable box. --This is an internal note--"
      }
    ]
  }
}

{
  "order": {
    "channel_id": 45465,
    "due_date": "31/01/2018",
    "number": "rdr1234",
    "send_notification_email": true,
    "line_items_attributes": [
      {
        "price_per_unit": "75.000",
        "taxless_discount_per_unit": "0.00",
        "quantity": "1",
        "tax_rate": 0.2,
        "sellable_id": 13847534,
        "additional_options": "This is a custom field for this line item"
      },
      {
        "price_per_unit": "150.000",
        "taxless_discount_per_unit": "30.00",
        "quantity": "1",
        "tax_rate": 0.2,
        "sellable_id": 14358568,
        "additional_options": "This thing is a thing"
      }
    ],
    "additional_order_level_taxless_discount": "19.50",
    "delivery_method_id": 171784,
    "delivery_cost": "2.00",
    "total_tax": "35.54",
    "total_discounts": "49.5",
    "payment_attributes": {
      "payment_type": "paypal",
      "reference_number": "PPP1234"
    },
    "customer_attributes": {
      "phone": "07891234567",
      "mobile": "07891234567",
      "email": "baggins@ringbearers.org",
      "billing_address_attributes": {
        "id": "",
        "first_name": "Frodo",
        "last_name": "Baggins",
        "company": "The Ring Bearers",
        "address1": "The New Bag End",
        "address2": "1st Avenue",
        "city": "Valinor",
        "state": "The Undying Lands",
        "zip": "VA1 1NB",
        "country": "GB",
        "phone": "07891234567",
        "email": "baggins@ringbearers.org"
      }
    },
    "deliver_to_attributes": {
      "first_name": "Samwise",
      "last_name": "Gamgee",
      "company": "The Fellowship",
      "address1": "Bag End",
      "address2": "Hobbiton",
      "city": "Shire",
      "state": "Middle Earth",
      "zip": "SH1 1BG",
      "country": "GB",
      "phone": "07891234567",
      "email": "Gamgee@fellowship.net",
      "id": ""
    },
    "customer_note_attributes": {
      "text": "Please tell Sam to look after this puppy. --This is a customer note--"
    },
    "employee_notes_attributes": [
      {
        "text": "Package contains a dog. Use suitable box. --This is an internal note--"
      }
    ]
  }
}

{
  "order": {
    "channel_id": 45465,
    "customer_id": 12137952,
    "deliver_to_id": 26465395,
    "delivery_method_id": 171784,
    "line_items_attributes": [
      {
        "sellable_id": 13847534,
        "price_per_unit": "75.000",
        "quantity": "1"
      }
    ],
    "payment_attributes": {
      "payment_type": "paypal"
    }
  }
}

{
  "order": {
    "channel_id": 45465,
    "line_items_attributes": [
      {
        "price_per_unit": "75.000",
        "quantity": "1",
        "sellable_id": 13847534
      }
    ],
    "delivery_method_id": 171784,
    "payment_attributes": {
      "payment_type": "paypal"
    },
    "customer_attributes": {
      "phone": "07891234567",
      "email": "baggins@ringbearers.org",
      "billing_address_attributes": {
        "first_name": "Frodo",
        "last_name": "Baggins",
        "address1": "The New Bag End",
        "city": "Valinor",
        "state": "The Undying Lands",
        "zip": "VA1 1NB",
        "country": "GB"
      }
    },
    "deliver_to_attributes": {
      "first_name": "Frodo",
      "last_name": "Baggins",
      "address1": "The New Bag End",
      "city": "Valinor",
      "state": "The Undying Lands",
      "zip": "VA1 1NB",
      "country": "GB"
    }
  }
}

Responses

201

Created

object

id

number

cancel_reason

nullable

refund_amount

nullable

send_refund_email

nullable

cancelled_at

nullable

created_at

string

customer_viewable_notes

nullable

delivery_cost

number

due_date

string

dispatch_date

nullable

international

boolean

notes

nullable

number

string

receipt_printed

boolean

send_notification_email

boolean

shipped_at

nullable

status

string

subtotal_price

number

total_discounts

number

total_price

number

total_tax

number

total_fees

number

buyer_user_id

nullable

updated_at

string

payment

object

id

number

order_id

number

payment_type

string

reference_number

string

created_at

string

updated_at

string

card_number

nullable

created_by_id

number

till_id

nullable

fulfilled_by_amazon

boolean

is_amazon_prime

boolean

is_amazon_premium_order

boolean

additional_order_level_taxless_discount

number

restock_shipped_items

boolean

adjustment_amount

number

tags

Array

cancelled_by

nullable

created_by

object

id

number

login

string

email

string

location

nullable

guide_completed_message_viewed

nullable

orders_walkthrough_viewed

boolean

default_warehouse_id

nullable

created_at

string

updated_at

string

company

object

id

number

name

string

created_at

string

updated_at

string

referring_website

nullable

card_valid

boolean

stripe_customer_id

nullable

has_right_to_use_veeqo

boolean

subscription_status

string

billing_period_started

nullable

subscription_plan_id

number

chargify_product_handle

string

chargify_current_plan

object

name

string

planId

string

chargeType

string

pricing

string

setup_fee

nullable

product_handle

string

product_url

nullable

features

object

users

string

products

string

orders

string

stores

string

support

string

product_pusher

boolean

stock_take

boolean

available

boolean

setting

object

currency_code

string

phone_number

string

subscription_plan

object

id

number

name

string

stripe_plan_id

string

billing_interval

string

updated_by

nullable

delivery_method

object

id

number

name

string

cost

number

deliver_to

object

id

number

first_name

string

last_name

string

email

string

company

string

address1

string

address2

string

city

string

country

string

state

string

zip

string

phone

string

channel

object

id

number

type_code

string

created_by_id

number

name

string

currency_code

string

state

string

url

nullable

shopify_url

nullable

ebay_url

nullable

ebay_site_code_id

number

country

nullable

region

string

city

string

address_line_1

string

address_line_2

string

post_code

string

pulled_products_at

nullable

pulled_orders_at

nullable

pending_setup

boolean

seller_id

nullable

marketplace_id

nullable

mws_auth_token

nullable

deleted_at

nullable

deleted_by_id

nullable

api2cart_store_key

nullable

bridge_url

nullable

bridge_verified

nullable

pull_pending_orders

boolean

default_send_shipment_email

boolean

automatic_product_linking_disabled

boolean

update_remote_order

boolean

successfully_fetched_stock_levels_at

nullable

create_product_if_unmatched

boolean

skip_title_matching

boolean

email

string

skip_fba_orders_and_products

boolean

pull_stock_level_required

boolean

pull_product_properties

boolean

pull_historical_orders

boolean

adjust_orders_tax_rate

nullable

send_notification_emails_to_customers

boolean

end_ebay_listing_on_out_of_stock

boolean

update_product_attributes

boolean

max_qty_to_advert

number

min_threshold_qty

number

percent_of_qty

number

always_set_qty

number

veeqo_dictates_stock_level

boolean

with_fba

boolean

first_sync_finish_notice_marked_as_read

boolean

pull_unpaid_shopify_orders

boolean

create_product_on_ended_listings

boolean

link_to_products_linked_to_current_channel

boolean

weight_unit

nullable

import_cost_price

boolean

veeqo_dictates_price

boolean

keep_inventory_tracking_value

boolean

marketplace_country

nullable

time_zone

nullable

time_zone_offset

nullable

amazon_fulfillment_enabled

boolean

import_product_tags

boolean

import_product_brands

boolean

channel_warehouses

Array

warehouses

Array

stock_level_update_requests

Array

amazon_fulfillment_setting

nullable

amazon_channel_specific

nullable

api2cart_channel_specific

nullable

additional_api2cart_site

nullable

time_since_product_sync

nullable

time_since_order_sync

nullable

time_since_tried_fetch_stock_level

nullable

time_since_successfully_fetch_stock_level

nullable

default_warehouse

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

display_position

number

remote

boolean

customer

object

id

number

email

string

phone

string

mobile

string

created_by_id

number

billing_address

object

id

number

first_name

string

last_name

string

address1

string

address2

string

city

string

company

string

country

string

state

string

zip

string

phone

string

email

string

shipping_addresses

Array<object>

object

id

number

first_name

string

last_name

string

email

string

company

string

address1

string

address2

string

city

string

country

string

state

string

zip

string

phone

string

customer_note

object

id

number

text

string

order_id

number

allocations

Array<object>

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

number

quantity

number

picked_quantity

number

created_at

string

updated_at

string

sellable

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

string

hs_tariff_number

nullable

tax_rate

number

main_image

object

id

number

binary_data

nullable

content_type

nullable

display_position

nullable

created_by_id

nullable

updated_by_id

nullable

deleted_at

nullable

deleted_by_id

nullable

created_at

string

updated_at

string

src

nullable

product_id

number

picture_file_name

string

picture_content_type

string

picture_file_size

number

picture_updated_at

string

picture_order

number

estimated_delivery

nullable

deleted_at

nullable

deleted_by_id

nullable

description

string

main_image_src

string

stock_entries

Array<object>

object

sellable_id

number

warehouse_id

number

infinite

boolean

allocated_stock_level

number

warehouse

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

display_position

number

location

string

stock_running_low

boolean

updated_at

string

incoming_stock_level

number

physical_stock_level

number

available_stock_level

number

sellable_on_hand_value

number

variant_option_specifics

Array<object>

object

id

number

product_specific_id

number

product_property_id

number

product_property_name

string

value

string

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

display_position

number

updated_at

string

updated_by_id

nullable

requested_carrier_account

nullable

employee_notes

Array<object>

object

id

number

text

string

order_id

number

created_at

string

created_by

object

id

number

login

string

email

string

location

nullable

guide_completed_message_viewed

nullable

orders_walkthrough_viewed

boolean

default_warehouse_id

nullable

created_at

string

updated_at

string

company

object

id

number

name

string

created_at

string

updated_at

string

referring_website

nullable

card_valid

boolean

stripe_customer_id

nullable

has_right_to_use_veeqo

boolean

subscription_status

string

billing_period_started

nullable

subscription_plan_id

number

chargify_product_handle

string

chargify_current_plan

object

name

string

planId

string

chargeType

string

pricing

string

setup_fee

nullable

product_handle

string

product_url

nullable

features

object

users

string

products

string

orders

string

stores

string

support

string

product_pusher

boolean

stock_take

boolean

available

boolean

setting

object

currency_code

string

phone_number

string

subscription_plan

object

id

number

name

string

stripe_plan_id

string

billing_interval

string

line_items

Array<object>

object

id

required

number

price_per_unit

required

number

quantity

required

number

tax_rate

required

number

taxless_discount_per_unit

required

number

additional_options

required

nullable

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

string

nullable

hs_tariff_number

nullable

tax_rate

number

main_image

object

id

number

binary_data

nullable

content_type

nullable

display_position

nullable

created_by_id

nullable

updated_by_id

nullable

deleted_at

nullable

deleted_by_id

nullable

created_at

string

updated_at

string

src

nullable

product_id

number

picture_file_name

string

picture_content_type

string

picture_file_size

number

picture_updated_at

string

picture_order

number

estimated_delivery

nullable

deleted_at

nullable

deleted_by_id

nullable

description

string

main_image_src

string

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

string

nullable

post_code

string

inventory_type_code

string

default_min_reorder

number

click_and_collect_enabled

boolean

click_and_collect_days

string

nullable

created_by_id

number

updated_by_id

nullable

deleted_at

nullable

deleted_by_id

nullable

created_at

string

updated_at

string

phone

string

nullable

requested_carrier_account

nullable

display_position

number

location

required

string

nullable

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

id

number

variant_option_specifics

Array<object>

object

id

number

product_specific_id

number

product_property_id

number

product_property_name

string

value

string

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

returns

Array

allocated_completely

boolean

picked_completely

boolean

fulfillment_channel_order

nullable

Example

{
  "id": 13359622,
  "cancel_reason": null,
  "refund_amount": null,
  "send_refund_email": null,
  "cancelled_at": null,
  "created_at": "2018-01-19T18:11:06.820Z",
  "customer_viewable_notes": null,
  "delivery_cost": 2,
  "due_date": "2018-01-31T00:00:00.000Z",
  "dispatch_date": null,
  "international": false,
  "notes": null,
  "number": "rdr1234",
  "receipt_printed": false,
  "send_notification_email": true,
  "shipped_at": null,
  "status": "awaiting_stock",
  "subtotal_price": 175.5,
  "total_discounts": 49.5,
  "total_price": 213.04,
  "total_tax": 35.54,
  "total_fees": 0,
  "buyer_user_id": null,
  "updated_at": "2018-01-19T18:11:07.098Z",
  "payment": {
    "id": 13177340,
    "order_id": 13359622,
    "payment_type": "paypal",
    "reference_number": "PPP1234",
    "created_at": "2018-01-19T18:11:06.831Z",
    "updated_at": "2018-01-19T18:11:06.869Z",
    "card_number": null,
    "created_by_id": 23005
  },
  "till_id": null,
  "fulfilled_by_amazon": false,
  "is_amazon_prime": false,
  "is_amazon_premium_order": false,
  "additional_order_level_taxless_discount": 19.5,
  "restock_shipped_items": false,
  "adjustment_amount": 0,
  "tags": [],
  "cancelled_by": null,
  "created_by": {
    "id": 12345,
    "login": "Phil Reynolds",
    "email": "phil+api@veeqo.com",
    "location": null,
    "guide_completed_message_viewed": null,
    "orders_walkthrough_viewed": false,
    "default_warehouse_id": null,
    "created_at": "2017-07-04T09:40:37.515Z",
    "updated_at": "2017-12-20T11:56:02.938Z",
    "company": {
      "id": 12345,
      "name": "Phil",
      "created_at": "2017-07-04T09:40:37.495Z",
      "updated_at": "2017-12-22T12:59:57.854Z",
      "referring_website": null,
      "card_valid": false,
      "stripe_customer_id": null,
      "has_right_to_use_veeqo": true,
      "subscription_status": "trialing",
      "billing_period_started": null,
      "subscription_plan_id": 62,
      "chargify_product_handle": "trial",
      "chargify_current_plan": {
        "name": "Unlimited",
        "planId": "unlimited-monthly-veeqo",
        "chargeType": "monthly",
        "pricing": "£9999",
        "setup_fee": null,
        "product_handle": "monthly-unlimited-9999",
        "product_url": null,
        "features": {
          "users": "Unlimited",
          "products": "Unlimited",
          "orders": "Unlimited",
          "stores": "Unlimited",
          "support": "Unlimited",
          "product_pusher": true,
          "stock_take": true
        },
        "available": false
      },
      "setting": {
        "currency_code": "GBP",
        "phone_number": "07812345678"
      },
      "subscription_plan": {
        "id": 62,
        "name": "Business[Monthly]",
        "stripe_plan_id": "BUSINESS_MONTHLY_99999",
        "billing_interval": "month"
      }
    }
  },
  "updated_by": null,
  "delivery_method": {
    "id": 171784,
    "name": "Delivery Method #2",
    "cost": 2
  },
  "deliver_to": {
    "id": 26463776,
    "first_name": "Samwise",
    "last_name": "Gamgee",
    "email": "Gamgee@fellowship.net",
    "company": "The Fellowship",
    "address1": "Bag End",
    "address2": "Hobbiton",
    "city": "Shire",
    "country": "GB",
    "state": "Middle Earth",
    "zip": "SH1 1BG",
    "phone": "07891234567"
  },
  "channel": {
    "id": 12345,
    "type_code": "direct",
    "created_by_id": 12345,
    "name": "Phone",
    "currency_code": "GBP",
    "state": "active",
    "url": null,
    "shopify_url": null,
    "ebay_url": null,
    "ebay_site_code_id": 3,
    "country": null,
    "region": "",
    "city": "",
    "address_line_1": "",
    "address_line_2": "",
    "post_code": "",
    "pulled_products_at": null,
    "pulled_orders_at": null,
    "pending_setup": true,
    "seller_id": null,
    "marketplace_id": null,
    "mws_auth_token": null,
    "deleted_at": null,
    "deleted_by_id": null,
    "api2cart_store_key": null,
    "bridge_url": null,
    "bridge_verified": null,
    "pull_pending_orders": false,
    "default_send_shipment_email": true,
    "automatic_product_linking_disabled": false,
    "update_remote_order": true,
    "successfully_fetched_stock_levels_at": null,
    "create_product_if_unmatched": true,
    "skip_title_matching": true,
    "email": "phil+api@veeqo.com",
    "skip_fba_orders_and_products": true,
    "pull_stock_level_required": true,
    "pull_product_properties": true,
    "pull_historical_orders": false,
    "adjust_orders_tax_rate": null,
    "send_notification_emails_to_customers": false,
    "end_ebay_listing_on_out_of_stock": false,
    "update_product_attributes": true,
    "max_qty_to_advert": 0,
    "min_threshold_qty": 0,
    "percent_of_qty": 100,
    "always_set_qty": 0,
    "veeqo_dictates_stock_level": true,
    "with_fba": false,
    "first_sync_finish_notice_marked_as_read": false,
    "pull_unpaid_shopify_orders": false,
    "create_product_on_ended_listings": true,
    "link_to_products_linked_to_current_channel": true,
    "weight_unit": null,
    "import_cost_price": true,
    "veeqo_dictates_price": false,
    "keep_inventory_tracking_value": false,
    "marketplace_country": null,
    "time_zone": null,
    "time_zone_offset": null,
    "amazon_fulfillment_enabled": false,
    "import_product_tags": true,
    "import_product_brands": true,
    "channel_warehouses": [],
    "warehouses": [],
    "stock_level_update_requests": [],
    "amazon_fulfillment_setting": null,
    "amazon_channel_specific": null,
    "api2cart_channel_specific": null,
    "additional_api2cart_site": null,
    "time_since_product_sync": null,
    "time_since_order_sync": null,
    "time_since_tried_fetch_stock_level": null,
    "time_since_successfully_fetch_stock_level": null,
    "default_warehouse": {
      "id": 12345,
      "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": 12345,
      "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,
      "display_position": 9999
    },
    "remote": false
  },
  "customer": {
    "id": 12137221,
    "email": "baggins@ringbearers.org",
    "phone": "07891234567",
    "mobile": "07891234567",
    "created_by_id": 12345,
    "billing_address": {
      "id": 26463775,
      "first_name": "Frodo",
      "last_name": "Baggins",
      "address1": "The New Bag End",
      "address2": "1st Avenue",
      "city": "Valinor",
      "company": "The Ring Bearers",
      "country": "GB",
      "state": "The Undying Lands",
      "zip": "VA1 1NB",
      "phone": "07891234567",
      "email": "baggins@ringbearers.org"
    },
    "shipping_addresses": [
      {
        "id": 26463776,
        "first_name": "Samwise",
        "last_name": "Gamgee",
        "email": "Gamgee@fellowship.net",
        "company": "The Fellowship",
        "address1": "Bag End",
        "address2": "Hobbiton",
        "city": "Shire",
        "country": "GB",
        "state": "Middle Earth",
        "zip": "SH1 1BG",
        "phone": "07891234567"
      }
    ]
  },
  "customer_note": {
    "id": 1013050,
    "text": "Please tell Sam to look after this puppy. --This is a customer note--",
    "order_id": 13359622
  },
  "allocations": [
    {
      "id": 10214654,
      "updated_at": "2018-01-19T18:11:07.095Z",
      "created_at": "2018-01-19T18:11:06.886Z",
      "total_weight": 0,
      "weight_unit": "g",
      "allocated_by_id": 12345,
      "order_id": 13359622,
      "packed_completely": null,
      "line_items": [
        {
          "id": 13715700,
          "quantity": 1,
          "picked_quantity": 0,
          "created_at": "2018-01-19T18:11:06.891Z",
          "updated_at": "2018-01-19T18:11:06.891Z",
          "sellable": {
            "total_quantity_sold": 8,
            "allocated_stock_level_at_all_warehouses": 8,
            "id": 13847534,
            "type": "ProductVariant",
            "title": "Black",
            "sku_code": "M2IEG-B",
            "upc_code": "4044155094916",
            "model_number": "",
            "price": 75,
            "cost_price": 40,
            "min_reorder_level": 0,
            "quantity_to_reorder": 0,
            "created_by_id": 12345,
            "created_at": "2017-09-29T09:45:01.265Z",
            "updated_at": "2018-01-19T18:11:07.111Z",
            "weight_grams": 0,
            "weight_unit": "g",
            "product_title": "Sennheiser Momentum In-Ear",
            "full_title": "Sennheiser Momentum In-Ear Black",
            "sellable_title": "Black",
            "profit": 35,
            "margin": 46.67,
            "tax_rate": 20,
            "product": {
              "id": 5793641,
              "title": "Sennheiser Momentum In-Ear",
              "weight": 0,
              "origin_country": "",
              "hs_tariff_number": null,
              "tax_rate": 0,
              "main_image": {
                "id": 10319279,
                "binary_data": null,
                "content_type": null,
                "display_position": null,
                "created_by_id": null,
                "updated_by_id": null,
                "deleted_at": null,
                "deleted_by_id": null,
                "created_at": "2017-08-21T11:50:24.545Z",
                "updated_at": "2017-08-21T11:50:27.358Z",
                "src": null,
                "product_id": 5793641,
                "picture_file_name": "senn.jpg",
                "picture_content_type": "image/jpeg",
                "picture_file_size": 165161,
                "picture_updated_at": "2017-08-21T11:50:24.450Z",
                "picture_order": 0
              },
              "estimated_delivery": null,
              "deleted_at": null,
              "deleted_by_id": null,
              "description": "Quintessential. Forward Thinking. Custom machined stainless steel sound tunnels for acoustic precision.",
              "main_image_src": "https://veeqo-production-storage.s3.amazonaws.com/images/10319279/senn_original.jpg?1503316224"
            },
            "stock_entries": [
              {
                "sellable_id": 13847534,
                "warehouse_id": 12345,
                "infinite": false,
                "allocated_stock_level": 8,
                "warehouse": {
                  "id": 12345,
                  "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": 12345,
                  "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,
                  "display_position": 9999
                },
                "location": "flow",
                "stock_running_low": false,
                "updated_at": "2018-01-19T18:11:06.897Z",
                "incoming_stock_level": 0,
                "physical_stock_level": 21,
                "available_stock_level": 13,
                "sellable_on_hand_value": 840
              }
            ],
            "variant_option_specifics": [
              {
                "id": 6083049,
                "product_specific_id": 2622355,
                "product_property_id": 58230,
                "product_property_name": "Colour",
                "value": "Black"
              }
            ],
            "variant_property_specifics": [],
            "measurement_attributes": {
              "id": 12268074,
              "width": 0,
              "height": 0,
              "depth": 0,
              "dimensions_unit": "cm"
            },
            "images": [],
            "active_channels": [],
            "channel_sellables": [],
            "available_stock_level_at_all_warehouses": 13,
            "stock_level_at_all_warehouses": 21,
            "on_hand_value": 840,
            "inventory": {
              "infinite": false,
              "physical_stock_level_at_all_warehouses": 21,
              "allocated_stock_level_at_all_warehouses": 8,
              "available_stock_level_at_all_warehouses": 13,
              "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": 12345,
        "default_min_reorder": 0,
        "deleted_at": null,
        "deleted_by_id": null,
        "id": 12345,
        "inventory_type_code": "wavg",
        "name": "My Warehouse",
        "phone": null,
        "post_code": "",
        "region": "",
        "display_position": 9999,
        "updated_at": "2017-07-04T09:40:37.539Z",
        "updated_by_id": null,
        "requested_carrier_account": null
      }
    }
  ],
  "employee_notes": [
    {
      "id": 887051,
      "text": "Package contains a dog. Use suitable box. --This is an internal note--",
      "order_id": 13359622,
      "created_at": "2018-01-19T18:11:06.850Z",
      "created_by": {
        "id": 12345,
        "login": "Phil Reynolds",
        "email": "phil+apitest@veeqo.com",
        "location": null,
        "guide_completed_message_viewed": null,
        "orders_walkthrough_viewed": false,
        "default_warehouse_id": null,
        "created_at": "2017-07-04T09:40:37.515Z",
        "updated_at": "2017-12-20T11:56:02.938Z",
        "company": {
          "id": 12345,
          "name": "Phil",
          "created_at": "2017-07-04T09:40:37.495Z",
          "updated_at": "2017-12-22T12:59:57.854Z",
          "referring_website": null,
          "card_valid": false,
          "stripe_customer_id": null,
          "has_right_to_use_veeqo": true,
          "subscription_status": "trialing",
          "billing_period_started": null,
          "subscription_plan_id": 62,
          "chargify_product_handle": "trial",
          "chargify_current_plan": {
            "name": "Unlimited",
            "planId": "unlimited-monthly-veeqo",
            "chargeType": "monthly",
            "pricing": "£9999",
            "setup_fee": null,
            "product_handle": "monthly-unlimited-9999",
            "product_url": null,
            "features": {
              "users": "Unlimited",
              "products": "Unlimited",
              "orders": "Unlimited",
              "stores": "Unlimited",
              "support": "Unlimited",
              "product_pusher": true,
              "stock_take": true
            },
            "available": false
          },
          "setting": {
            "currency_code": "GBP",
            "phone_number": "07812345678"
          },
          "subscription_plan": {
            "id": 62,
            "name": "Business[Monthly]",
            "stripe_plan_id": "BUSINESS_MONTHLY_12345",
            "billing_interval": "month"
          }
        }
      }
    }
  ],
  "line_items": [
    {
      "id": 17976358,
      "price_per_unit": 150,
      "quantity": 1,
      "tax_rate": 0.2,
      "taxless_discount_per_unit": 30,
      "additional_options": null,
      "created_at": "2018-01-19T18:11:06.829Z",
      "updated_at": "2018-01-19T18:11:06.829Z",
      "sellable": {
        "total_quantity_sold": 14,
        "allocated_stock_level_at_all_warehouses": 13,
        "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": 12345,
        "created_at": "2017-10-16T15:26:15.810Z",
        "updated_at": "2018-01-19T18:08:36.295Z",
        "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": 12345,
            "infinite": false,
            "allocated_stock_level": 13,
            "warehouse": {
              "id": 12345,
              "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": 12345,
              "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,
              "display_position": 9999
            },
            "location": "Kennels",
            "stock_running_low": false,
            "updated_at": "2018-01-19T18:08:36.077Z",
            "incoming_stock_level": 0,
            "physical_stock_level": 9,
            "available_stock_level": -4,
            "sellable_on_hand_value": 900
          },
          {
            "id": 18867592,
            "sellable_id": 14358568,
            "warehouse_id": 12345,
            "infinite": false,
            "allocated_stock_level": 0,
            "warehouse": {
              "id": 12345,
              "name": "Warehouse #2",
              "user_id": null,
              "address_line_1": "",
              "address_line_2": "",
              "city": "",
              "region": "",
              "country": "GB",
              "post_code": "",
              "inventory_type_code": "wavg",
              "default_min_reorder": 0,
              "click_and_collect_enabled": false,
              "click_and_collect_days": "",
              "created_by_id": 12345,
              "updated_by_id": null,
              "deleted_at": null,
              "deleted_by_id": null,
              "created_at": "2018-01-18T12:22:50.522Z",
              "updated_at": "2018-01-18T12:22:50.522Z",
              "phone": "1234567890",
              "requested_carrier_account": null,
              "display_position": 9999
            },
            "location": null,
            "stock_running_low": false,
            "updated_at": "2018-01-19T18:08:06.694Z",
            "incoming_stock_level": 0,
            "physical_stock_level": 100,
            "available_stock_level": 100,
            "sellable_on_hand_value": 10000
          }
        ],
        "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": 96,
        "stock_level_at_all_warehouses": 109,
        "on_hand_value": 10900,
        "inventory": {
          "infinite": false,
          "physical_stock_level_at_all_warehouses": 109,
          "allocated_stock_level_at_all_warehouses": 13,
          "available_stock_level_at_all_warehouses": 96,
          "incoming_stock_level_at_all_warehouses": 0
        },
        "weight": 0
      }
    },
    {
      "id": 17976357,
      "price_per_unit": 75,
      "quantity": 1,
      "tax_rate": 0.2,
      "taxless_discount_per_unit": 0,
      "additional_options": null,
      "created_at": "2018-01-19T18:11:06.826Z",
      "updated_at": "2018-01-19T18:11:06.826Z",
      "sellable": {
        "total_quantity_sold": 8,
        "allocated_stock_level_at_all_warehouses": 8,
        "id": 13847534,
        "type": "ProductVariant",
        "title": "Black",
        "sku_code": "M2IEG-B",
        "upc_code": "4044155094916",
        "model_number": "",
        "price": 75,
        "cost_price": 40,
        "min_reorder_level": 0,
        "quantity_to_reorder": 0,
        "created_by_id": 12345,
        "created_at": "2017-09-29T09:45:01.265Z",
        "updated_at": "2018-01-19T18:11:07.111Z",
        "weight_grams": 0,
        "weight_unit": "g",
        "product_title": "Sennheiser Momentum In-Ear",
        "full_title": "Sennheiser Momentum In-Ear Black",
        "sellable_title": "Black",
        "profit": 35,
        "margin": 46.67,
        "tax_rate": 20,
        "product": {
          "id": 5793641,
          "title": "Sennheiser Momentum In-Ear",
          "weight": 0,
          "origin_country": "",
          "hs_tariff_number": null,
          "tax_rate": 0,
          "main_image": {
            "id": 10319279,
            "binary_data": null,
            "content_type": null,
            "display_position": null,
            "created_by_id": null,
            "updated_by_id": null,
            "deleted_at": null,
            "deleted_by_id": null,
            "created_at": "2017-08-21T11:50:24.545Z",
            "updated_at": "2017-08-21T11:50:27.358Z",
            "src": null,
            "product_id": 5793641,
            "picture_file_name": "senn.jpg",
            "picture_content_type": "image/jpeg",
            "picture_file_size": 165161,
            "picture_updated_at": "2017-08-21T11:50:24.450Z",
            "picture_order": 0
          },
          "estimated_delivery": null,
          "deleted_at": null,
          "deleted_by_id": null,
          "description": "Quintessential. Forward Thinking. Custom machined stainless steel sound tunnels for acoustic precision.",
          "main_image_src": "https://veeqo-production-storage.s3.amazonaws.com/images/10319279/senn_original.jpg?1503316224"
        },
        "stock_entries": [
          {
            "sellable_id": 13847534,
            "warehouse_id": 12345,
            "infinite": false,
            "allocated_stock_level": 8,
            "warehouse": {
              "id": 12345,
              "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": 12345,
              "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,
              "display_position": 9999
            },
            "location": "flow",
            "stock_running_low": false,
            "updated_at": "2018-01-19T18:11:06.897Z",
            "incoming_stock_level": 0,
            "physical_stock_level": 21,
            "available_stock_level": 13,
            "sellable_on_hand_value": 840
          }
        ],
        "variant_option_specifics": [
          {
            "id": 6083049,
            "product_specific_id": 2622355,
            "product_property_id": 58230,
            "product_property_name": "Colour",
            "value": "Black"
          }
        ],
        "variant_property_specifics": [],
        "measurement_attributes": {
          "id": 12268074,
          "width": 0,
          "height": 0,
          "depth": 0,
          "dimensions_unit": "cm"
        },
        "images": [],
        "active_channels": [],
        "channel_sellables": [],
        "available_stock_level_at_all_warehouses": 13,
        "stock_level_at_all_warehouses": 21,
        "on_hand_value": 840,
        "inventory": {
          "infinite": false,
          "physical_stock_level_at_all_warehouses": 21,
          "allocated_stock_level_at_all_warehouses": 8,
          "available_stock_level_at_all_warehouses": 13,
          "incoming_stock_level_at_all_warehouses": 0
        },
        "weight": 0
      }
    }
  ],
  "returns": [],
  "allocated_completely": false,
  "picked_completely": false,
  "fulfillment_channel_order": null
}

Headers

Location

string

X-Runtime

string