Order Create
POST
{{api_url}}/shop/order/Create an order
Authorization
Bearer token, sent in the Authorization header. Inherited from the collection.
Headers
| Key | Value | Description |
|---|---|---|
Content-Type | application/json |
Body
{
"order_source": "Amazon",
"order_date": "2018-05-12 17:56:06",
"email": "mark@infiplex.com",
"phone": "123-123-1234",
"ship_first_name": "Mark",
"ship_last_name": "Jacob",
"ship_company": "",
"ship_street1": "1234 Main St",
"ship_street2": "",
"ship_city": "Naperville",
"ship_state": "IL",
"ship_region": "",
"ship_zip": "60540",
"ship_country": "US",
"bill_first_name": "Mark",
"bill_last_name": "Jacob",
"bill_company": "",
"bill_street1": "1234 Main St",
"bill_street2": "",
"bill_city": "Naperville",
"bill_state": "IL",
"bill_region": "",
"bill_zip": "60540",
"bill_country": "US",
"ship_price": "2.95",
"ship_handling": "0.00",
"ship_identifier": "",
"ship_type": "0",
"ship_label": "UPS Ground",
"ship_weight_total": "0.00",
"ship_speed": "1",
"item_total": "14.99",
"discount_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"order_total": "17.94",
"cc_type": "",
"cc_num": null,
"cc_exp_mon": "",
"cc_exp_year": "",
"cc_last_four": "",
"is_processed": "0",
"external_order_num": "1111-048073-66777",
"external_order_source": null,
"fully_shipped": "1",
"is_amazon_payment": "0",
"is_paypal_payment": "0",
"is_canceled": "0",
"order_tag": null,
"in_process": "0",
"processed_by": null,
"processed_date": null,
"order_tak": null,
"order_referer": "",
"date_created": "2018-06-09 13:43:04",
"amazon_payment_order_id": null,
"po_number": null,
"session_id": null,
"user_unq_identifier": null,
"merchant_trans_id": null,
"merchant_customer_profile_id": null,
"merchant_customer_payment_profile_id": null,
"is_seller_fulfilled_prime": "0",
"gift_card_total": "0.00",
"is_walmart_dsv_ship_to_store": "0",
"additional_customer_order_id": null,
"payment_type": null,
"payment_note": null,
"merchant_name": null,
"external_external_order_num": null,
"external_external_order_source": null,
"estimated_ship_date": null,
"estimated_delivery_date": null,
"order_items": [
{
"shop_order_itemid": "1110",
"shop_order_item_orderid": "101769",
"shop_order_item_productid": "116",
"shop_order_item_skuid": null,
"shop_order_item_clientid": null,
"product_name": "Twinings Earl Grey Tea 24 ct",
"product_description": "",
"sku": "08756-1",
"sku_description": "",
"out_of_stock_message": null,
"price": "14.99",
"quantity": "1",
"ship_weight": "0.00",
"ship_weight_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"discount_total": "0.00",
"item_total": "14.99",
"tax_name": "",
"tax_rate": "0.000",
"external_itemid": "155239",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"item_cost": null,
"amazon_custom_prod": "0",
"amazon_custom_prod_processed": "0",
"is_amazon_fba": 0,
"item_note": null,
"item_upc": null,
"item_isbn": null,
"item_asin": null,
"item_gtin": null,
"item_ean": null,
"item_additional_id": null,
"option_info": null,
"input_option_info": null,
"quantity_shipped": "1",
"quantity_to_ship": 0,
"quantity_returned": 0,
"quantity_to_return": "1",
"customization_info": null
}
],
"coupons": null,
"notes": [
{
"note": "<strong>The following item(s) were sent to InfiPlex FBI for shipment:<br></strong>Ship qty: 1 of SKU ABC",
"date_created": "2024-10-02 17:52:45",
"is_checkout_note": "0"
},
{
"note": "This is another sample note",
"date_created": "2024-10-02 17:52:45",
"is_checkout_note": "0"
}
]
}Example Request
curl --location --request POST '{{api_url}}/shop/order/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{auth_token}}' \
--data '{
"order_source": "Amazon",
"order_date": "2018-05-12 17:56:06",
"email": "mark@infiplex.com",
"phone": "123-123-1234",
"ship_first_name": "Mark",
"ship_last_name": "Jacob",
"ship_company": "",
"ship_street1": "1234 Main St",
"ship_street2": "",
"ship_city": "Naperville",
"ship_state": "IL",
"ship_region": "",
"ship_zip": "60540",
"ship_country": "US",
"bill_first_name": "Mark",
"bill_last_name": "Jacob",
"bill_company": "",
"bill_street1": "1234 Main St",
"bill_street2": "",
"bill_city": "Naperville",
"bill_state": "IL",
"bill_region": "",
"bill_zip": "60540",
"bill_country": "US",
"ship_price": "2.95",
"ship_handling": "0.00",
"ship_identifier": "",
"ship_type": "0",
"ship_label": "UPS Ground",
"ship_weight_total": "0.00",
"ship_speed": "1",
"item_total": "14.99",
"discount_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"order_total": "17.94",
"cc_type": "",
"cc_num": null,
"cc_exp_mon": "",
"cc_exp_year": "",
"cc_last_four": "",
"is_processed": "0",
"external_order_num": "1111-048073-66777",
"external_order_source": null,
"fully_shipped": "1",
"is_amazon_payment": "0",
"is_paypal_payment": "0",
"is_canceled": "0",
"order_tag": null,
"in_process": "0",
"processed_by": null,
"processed_date": null,
"order_tak": null,
"order_referer": "",
"date_created": "2018-06-09 13:43:04",
"amazon_payment_order_id": null,
"po_number": null,
"session_id": null,
"user_unq_identifier": null,
"merchant_trans_id": null,
"merchant_customer_profile_id": null,
"merchant_customer_payment_profile_id": null,
"is_seller_fulfilled_prime": "0",
"gift_card_total": "0.00",
"is_walmart_dsv_ship_to_store": "0",
"additional_customer_order_id": null,
"payment_type": null,
"payment_note": null,
"merchant_name": null,
"external_external_order_num": null,
"external_external_order_source": null,
"estimated_ship_date": null,
"estimated_delivery_date": null,
"order_items": [
{
"shop_order_itemid": "1110",
"shop_order_item_orderid": "101769",
"shop_order_item_productid": "116",
"shop_order_item_skuid": null,
"shop_order_item_clientid": null,
"product_name": "Twinings Earl Grey Tea 24 ct",
"product_description": "",
"sku": "08756-1",
"sku_description": "",
"out_of_stock_message": null,
"price": "14.99",
"quantity": "1",
"ship_weight": "0.00",
"ship_weight_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"discount_total": "0.00",
"item_total": "14.99",
"tax_name": "",
"tax_rate": "0.000",
"external_itemid": "155239",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"item_cost": null,
"amazon_custom_prod": "0",
"amazon_custom_prod_processed": "0",
"is_amazon_fba": 0,
"item_note": null,
"item_upc": null,
"item_isbn": null,
"item_asin": null,
"item_gtin": null,
"item_ean": null,
"item_additional_id": null,
"option_info": null,
"input_option_info": null,
"quantity_shipped": "1",
"quantity_to_ship": 0,
"quantity_returned": 0,
"quantity_to_return": "1",
"customization_info": null
}
],
"coupons": null,
"notes": [
{
"note": "<strong>The following item(s) were sent to InfiPlex FBI for shipment:<br></strong>Ship qty: 1 of SKU ABC",
"date_created": "2024-10-02 17:52:45",
"is_checkout_note": "0"
},
{
"note": "This is another sample note",
"date_created": "2024-10-02 17:52:45",
"is_checkout_note": "0"
}
]
}'Example Responses
Order Create
Request
curl --location --request POST 'https://example.com/api/admin/shop/order/' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"order_source": "Amazon",
"order_date": "2018-05-12 17:56:06",
"email": "mark@infiplex.com",
"phone": "123-123-1234",
"ship_first_name": "Mark",
"ship_last_name": "Jacob",
"ship_company": "",
"ship_street1": "1234 Main St",
"ship_street2": "",
"ship_city": "Naperville",
"ship_state": "IL",
"ship_region": "",
"ship_zip": "60540",
"ship_country": "US",
"bill_first_name": "Mark",
"bill_last_name": "Jacob",
"bill_company": "",
"bill_street1": "1234 Main St",
"bill_street2": "",
"bill_city": "Naperville",
"bill_state": "IL",
"bill_region": "",
"bill_zip": "60540",
"bill_country": "US",
"ship_price": "2.95",
"ship_handling": "0.00",
"ship_identifier": "",
"ship_type": "0",
"ship_label": "UPS Ground",
"ship_weight_total": "0.00",
"ship_speed": "1",
"item_total": "14.99",
"discount_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"order_total": "17.94",
"cc_type": "",
"cc_num": null,
"cc_exp_mon": "",
"cc_exp_year": "",
"cc_last_four": "",
"is_processed": "0",
"external_order_num": "1111-048073-66777",
"external_order_source": null,
"fully_shipped": "1",
"is_amazon_payment": "0",
"is_paypal_payment": "0",
"is_canceled": "0",
"order_tag": null,
"in_process": "0",
"processed_by": null,
"processed_date": null,
"order_tak": null,
"order_referer": "",
"date_created": "2018-06-09 13:43:04",
"amazon_payment_order_id": null,
"po_number": null,
"session_id": null,
"user_unq_identifier": null,
"merchant_trans_id": null,
"merchant_customer_profile_id": null,
"merchant_customer_payment_profile_id": null,
"is_seller_fulfilled_prime": "0",
"gift_card_total": "0.00",
"is_walmart_dsv_ship_to_store": "0",
"additional_customer_order_id": null,
"payment_type": null,
"payment_note": null,
"merchant_name": null,
"external_external_order_num": null,
"external_external_order_source": null,
"estimated_ship_date": null,
"estimated_delivery_date": null,
"order_items": [
{
"product_name": "Twinings Earl Grey Tea 24 ct",
"product_description": "",
"sku": "08756-1",
"sku_description": "",
"out_of_stock_message": null,
"price": "14.99",
"quantity": "1",
"ship_weight": "0.00",
"ship_weight_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"discount_total": "0.00",
"item_total": "14.99",
"tax_name": "",
"tax_rate": "0.000",
"external_itemid": "155239",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"item_cost": null,
"amazon_custom_prod": "0",
"amazon_custom_prod_processed": "0",
"is_amazon_fba": 0,
"item_note": null,
"item_upc": null,
"item_isbn": null,
"item_asin": null,
"item_gtin": null,
"item_ean": null,
"item_additional_id": null,
"option_info": null,
"input_option_info": null,
"quantity_shipped": "1",
"quantity_to_ship": 0,
"quantity_returned": 0,
"quantity_to_return": "1",
"customization_info": null
}
],
"coupons": null,
"notes": null,
"additional_info": [
{
"info_name": "edi_doc",
"info_value": "12345"
},
{
"info_name": "edi_door",
"info_value": "abc"
},
{
"info_name": "some aditional info",
"info_value": "whatever info"
}
]
}'Response 200 OK
{
"orderid": 101772,
"order_key": "Qropg3Ozqv0V61cF46iPA8zt6VPEIDSjt0kiID5lMrrr9jpR61mJOjRCxBV1LPGBf1EXWvqQV1ocW6NFwcPQCVr4bVXugU5vz4jzX8706QUqMU4mfjEuORswASiufoJaptcXEDXq9LjpC5rn0UTSMfVnNzQsyMtX9Suwixnsiz"
}