--- title: "order.add" method: POST path: "/order.add.json" tags: ["order"] --- # order.add `POST /order.add.json` ## Request - Base URL: `https://api.api2cart.com/v1.1` - URL: `https://api.api2cart.com/v1.1/order.add.json` - Auth: API key in header `x-api-key` and API key in header `x-store-key` Add a new order to the cart. ## Request body - OrderAdd - `id` string: Defines order's id - `order_id` string: Defines the order id if it is supported by the cart - `store_id` string: Defines store id where the order should be assigned - `channel_id` string: Channel ID - `order_status` string, required: Defines order status. - `fulfillment_status` string: Create order with fulfillment status - `financial_status` string: Create order with financial status - `customer_email` string, required: Defines the customer specified by email for whom order has to be created - `customer_first_name` string: Specifies customer's first name - `customer_last_name` string: Specifies customer’s last name - `customer_phone` string: Specifies customer’s phone - `customer_country` string: Specifies customer's address ISO code or name of country - `customer_birthday` string: Specifies customer’s birthday - `customer_fax` string: Specifies customer’s fax - `is_guest` boolean: Indicates whether the customer is a guest customer - `order_payment_method` string: Defines order payment method.
Setting order_payment_method on Shopify will also change financial_status field value to 'paid' - `transaction_id` string: Payment transaction id - `currency` string: Currency code of order - `date` string: Specifies an order creation date in format Y-m-d H:i:s - `date_modified` string: Specifies order's modification date - `date_finished` string: Specifies order's finished date - `bill_first_name` string, required: Specifies billing first name - `bill_last_name` string, required: Specifies billing last name - `bill_address_1` string, required: Specifies first billing address - `bill_address_2` string: Specifies second billing address - `bill_city` string, required: Specifies billing city - `bill_postcode` string, required: Specifies billing postcode - `bill_state` string, required: Specifies billing state code - `bill_country` string, required: Specifies billing country code - `bill_company` string: Specifies billing company - `bill_phone` string: Specifies billing phone - `bill_fax` string: Specifies billing fax - `shipp_first_name` string: Specifies shipping first name - `shipp_last_name` string: Specifies shipping last name - `shipp_address_1` string: Specifies first shipping address - `shipp_address_2` string: Specifies second address line of a shipping street address - `shipp_city` string: Specifies shipping city - `shipp_postcode` string: Specifies shipping postcode - `shipp_state` string: Specifies shipping state code - `shipp_country` string: Specifies shipping country code - `shipp_company` string: Specifies shipping company - `shipp_phone` string: Specifies shipping phone - `shipp_fax` string: Specifies shipping fax - `subtotal_price` number: Total price of all ordered products multiplied by their number, excluding tax, shipping price and discounts - `tax_price` number: The value of tax cost for order - `total_price` number: Defines order's total price - `total_paid` number: Defines total paid amount for the order - `total_weight` integer: Defines the sum of all line item weights in grams for the order - `prices_inc_tax` boolean: Indicates whether prices and subtotal include tax. - `shipping_price` number: Specifies order's shipping price - `shipping_tax` number: Specifies order's shipping price tax - `discount` number: Specifies order's discount - `coupon_discount` number: Specifies order's coupon discount - `gift_certificate_discount` number: Discounts for order with gift certificates - `order_shipping_method` string: Defines order shipping method - `carrier_id` string: Defines tracking carrier id - `warehouse_id` string: This parameter is used for selecting a warehouse where you need to set/modify a product quantity. - `coupons` string[]: Coupons that will be applied to order - `tags` string: Order tags - `comment` string: Specifies order comment - `admin_comment` string: Specifies admin's order comment - `admin_private_comment` string: Specifies private admin's order comment - `send_notifications` boolean: Send notifications to customer after order was created - `send_admin_notifications` boolean: Notify admin when new order was created. - `external_source` string: Identifying the system used to generate the order - `inventory_behaviour` string: The behaviour to use when updating inventory.
Values description:
bypass = Do not claim inventory

decrement_ignoring_policy = Ignore the product's
inventory policy and claim amounts

decrement_obeying_policy = Obey the product's
inventory policy.

- `create_invoice` boolean: Defines whether the invoice is created automatically along with the order - `invoice_admin_comment` string: Specifies admin's order invoice comment - `note_attributes` object[]: Defines note attributes - `name` string - `value` string - `clear_cache` boolean: Is cache clear required - `origin` string: The source of the order - `fee_price` number: Specifies refund's fee price - `shipp_national_address` string: Specifies short national address code of a shipping address - `shipp_building_number` string: Specifies building number of a shipping address - `shipp_additional_number` string: Specifies additional number of a shipping address - `idempotency_key` string: A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes. - `order_item` object[], required - `order_item_id` string, required: Defines orders specified by order item id - `order_item_name` string, required: Defines orders specified by order item name - `order_item_model` string: Defines orders specified by order item model - `order_item_price` number, required: Defines orders specified by order item price - `order_item_quantity` integer, required: Defines orders specified by order item quantity - `order_item_weight` number: Defines orders specified by order item weight - `order_item_variant_id` string: Ordered product variant. Where x is order item ID - `order_item_tax` number: Percentage of tax for product order - `order_item_tax_class` string: Id of the tax class of product. - `order_item_price_includes_tax` boolean: Defines if item price includes tax - `order_item_parent` integer: Index of the parent grouped/bundle product - `order_item_parent_option_name` string: Option name of the parent grouped/bundle product - `order_item_allow_refund_items_separately` boolean: Indicates whether subitems of the grouped/bundle product can be refunded separately - `order_item_allow_ship_items_separately` boolean: Indicates whether subitems of the grouped/bundle product can be shipped separately - `order_item_option` object[] - `order_item_option_name` string: Ordered Product Option Name. Where x is order item ID, y is order item option ID - `order_item_option_value` string: Ordered product option value Where x is order item ID, y - order item option ID - `order_item_option_price` number: Ordered product option price Where x is order item ID, y - order item option ID - `order_item_property` object[] - `order_item_property_name` string: Ordered product property name. Where x is order item ID, y is order item property ID - `order_item_property_value` string: Ordered product property value. Where x is order item ID, y - order item property ID ## Response `200` successful operation - object - `return_code` integer - `return_message` string - `result` object - `order_id` string - `id` string, nullable - `customer_id` string, nullable --- [API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)