# Create Order

Create an order.

Endpoint: POST /orders
Version: 4
Security: bearerAuth

## Request fields (application/json):

  - `store_id` (string, required)
    The unique identifier for the store.
    Example: "1234"

  - `name` (string, required)
    The name of the recipient.
    Example: "Pramod Thomson"

  - `company` (string,null)
    The company name of the recipient (optional).

  - `address1` (string, required)
    The first line of the delivery address.
    Example: "30 Clearview Dr"

  - `address2` (string,null)
    The second line of the delivery address (optional).

  - `city` (string, required)
    The city where the recipient is located.
    Example: "Rock Springs"

  - `province_code` (string)
    The two-letter province or state code where the recipient is located.
    Example: "WY"

  - `postal_code` (string)
    The postal code or ZIP code of the recipient's location.
    Example: "82901"

  - `country_code` (string, required)
    The two-letter country code of the recipient's country.
    Example: "US"

  - `phone` (string,null)
    The recipient's phone number (optional).

  - `email` (string,null)
    The recipient's email address (optional).

  - `customer_id` (string,null)
    The customer ID associated with the order (optional).

  - `carrier_code` (string,null)
    The carrier code for shipping (optional).

  - `postage_code` (string,null)
    The postage code for shipping (optional).

  - `package_code` (string,null)
    The package code for shipping (optional).

  - `note` (string,null)
    Additional notes or comments for the order (optional).

  - `weight_unit` (string, required)
    Enum: "lbs", "kg", "g", "oz"

  - `weight` (number, required)
    The weight of the order in the specified weight unit.
    Example: 0.6

  - `value` (number, required)
    The total value of the order.
    Example: 10.5

  - `currency` (string, required)
    Enum: "CAD", "USD", "EUR", "AUD", "GBP"

  - `order_id` (string, required)
    The unique identifier for the order.
    Example: "1234-1233"

  - `order_at` (string, required)
    The date and time when the order was placed.
    Example: "2023-09-26 14:30:00"

  - `store` (string)
    Store Nickname or Identifier.
    Example: "My Shopify Store"

  - `items` (array, required)
    Order Line Items.

  - `items.item_id` (string)
    The unique identifier for the item.
    Example: 1234

  - `items.title` (string, required)
    The title or name of the item.
    Example: "Cool T-Shirt"

  - `items.sku` (string,null)
    The SKU (Stock Keeping Unit) of the item (optional).
    Example: "SKU123"

  - `items.hs_code` (string,null)
    The HS (Harmonized System) code for customs (optional). Required if the shipment country_of_origin is CN/HK
    Example: "620800"

  - `items.quantity` (number, required)
    The quantity of the item in the order.
    Example: 1

  - `items.value` (number, required)
    The value of the item.
    Example: 10

  - `items.country_of_origin` (string,null)
    The two-letter country code indicating the country of origin for the item (optional). Required if the shipment is being sent to US
    Example: "CN"

  - `items.warehouse_location` (string,null)
    The location of the item in the warehouse (optional).
    Example: "Warehouse A"

  - `tags` (array)
    The tags for the order.
    Example: "['this is a tag', 'this is another tag']"

## Response 200 fields (application/json):

  - `success` (boolean)
    Indicates whether the request was successful.

  - `order` (object)

  - `order.id` (integer)
    The unique identifier for the store.

  - `order.name` (string)
    The name of the store.

  - `order.company` (string)
    The company associated with the store.

  - `order.address1` (string)
    The first address line of the store.

  - `order.address2` (string)
    The second address line of the store.

  - `order.city` (string)
    The city where the store is located.

  - `order.province_code` (string)
    The province code of the store's location.

  - `order.postal_code` (string)
    The postal code of the store's location.

  - `order.country_code` (string)
    The country code of the store's location.

  - `order.phone` (string)
    The phone number of the store.

  - `order.email` (string)
    The email address associated with the store.

  - `order.customer_id` (string)
    The customer ID related to the store.

  - `order.carrier_code` (string)
    The carrier code associated with the store.

  - `order.postage_code` (string)
    The postage code used by the store.

  - `order.package_code` (string)
    The package code used by the store.

  - `order.note` (string)
    Additional notes related to the store.

  - `order.weight_unit` (string)
    The unit of weight used by the store.

  - `order.weight` (number)
    The weight associated with the store.

  - `order.value` (number)
    The value associated with the store.

  - `order.currency` (string)
    The currency code used by the store.

  - `order.order_id` (string)
    The order ID associated with the store.

  - `order.order_at` (string)
    The date and time of the order associated with the store.

  - `order.store` (string)
    The store name or identifier.

  - `order.tags` (array)
    An array of tags associated with the store.

  - `order.items` (array)
    An array of items associated with the store.

  - `order.items.item_id` (string)
    The unique identifier for the item.

  - `order.items.title` (string)
    The title or name of the item.

  - `order.items.sku` (string)
    The SKU (Stock Keeping Unit) of the item.

  - `order.items.hs_code` (string)
    The HS (Harmonized System) code of the item.

  - `order.items.quantity` (integer)
    The quantity of the item.

  - `order.items.value` (number)
    The value associated with the item.

  - `order.items.currency` (string)
    The currency code used for the item.

  - `order.items.country_of_origin` (string)
    The country of origin for the item.

  - `order.items.warehouse_location` (string)
    The warehouse location of the item.

  - `order.shipment` (object)

  - `order.shipment.ship_code` (string)
    Example: "2019JHSJDHSJ"

  - `order.shipment.name` (string)
    Example: "Pramod Thomson"

  - `order.shipment.address1` (string)
    Example: "30 Clearview Dr"

  - `order.shipment.address2` (string)
    Example: "Lot 2"

  - `order.shipment.city` (string)
    Example: "Rock Springs"

  - `order.shipment.province_code` (string)
    Example: "WY"

  - `order.shipment.postal_code` (string)
    Example: "82901"

  - `order.shipment.country_code` (string)
    Example: "US"

  - `order.shipment.weight_unit` (string)
    Enum: "lbs", "kg", "g", "oz"

  - `order.shipment.weight` (number)
    Example: 0.6

  - `order.shipment.length` (number)
    Example: 9

  - `order.shipment.width` (number)
    Example: 12

  - `order.shipment.height` (number)
    Example: 1

  - `order.shipment.size_unit` (string)
    Enum: "cm", "in"

  - `order.shipment.items` (array)

  - `order.shipment.items.description` (string)
    Example: "Two pair of socks"

  - `order.shipment.items.sku` (string,null)
    The SKU/ASIN of the item. Required for FBA shipments.
    Example: "SKU123"

  - `order.shipment.items.quantity` (integer)
    Example: 2

  - `order.shipment.items.value` (number)
    Example: 10

  - `order.shipment.items.currency` (string)
    Enum: "CAD", "USD", "EUR", "AUD", "GBP"

  - `order.shipment.items.country_of_origin` (string)
    Required if the shipment is being sent to US
    Example: "CN"

  - `order.shipment.items.hs_code` (string)
    Required if the shipment country_of_origin is CN/HK.
    Example: "123456"

  - `order.shipment.items.manufacturer_name` (string,null)
    The name of the item's manufacturer
    Example: "Acme Clothing Inc."

  - `order.shipment.items.manufacturer_address1` (string,null)
    The address of the item's manufacturer
    Example: "123 Manufacturing Blvd"

  - `order.shipment.items.manufacturer_city` (string,null)
    The city of the item's manufacturer
    Example: "Toronto"

  - `order.shipment.items.manufacturer_province_code` (string,null)
    The province/state code of the item's manufacturer
    Example: "ON"

  - `order.shipment.items.manufacturer_postal_code` (string,null)
    The postal/zip code of the item's manufacturer
    Example: "M5V 2H1"

  - `order.shipment.items.manufacturer_country_code` (string,null)
    The country code of the item's manufacturer
    Example: "CA"

  - `order.shipment.package_type` (string)
    Enum: "Parcel", "Legal Flat Rate Envelope", "Flat Rate PAdded Envelope", "Small Flat Rate Box", "Medium Flat Rate Box 1", "Medium Flat Rate Box 2", "Large Flat Rate Box", "Regional Rate Box A1", "Regional Rate Box A2", "Regional Rate Box B1", "Regional Rate Box B2", "Letter", "Large Envelope Or Flat", "Thick Envelope"

  - `order.shipment.postage_type` (string)
    Enum: "USPS First Class Mail", "USPS Priority Mail", "USPS Priority Mail Express", "USPS Parcel Select Ground", "USPS Media Mail", "USPS Library Mail", "USPS Express Mail International", "USPS Priority Mail International", "USPS First Class Mail International", "FedEx Ground", "UPS Standard", "PostNL International Packet", "PostNL International Packet Tracked", "APC Priority Worldwide", "APC Priority Worldwide Tracked", "APC Priority Worldwide Expedited", "APC Priority Worldwide Expedited(DDP)", "Stallion Economy USA", "Stallion Economy CA", "US Economy", "Intelcom Standard", "Ecom Next Day", "Canada Post Expedited", "Fleet Optics Express", "ICS Express", "UPS Express Saver"

  - `order.shipment.region` (string)
    Enum: "Ontario", "British Columbia", "Quebec"

  - `order.shipment.tracking_code` (string)
    Example: "9400111969000940000011"

  - `order.shipment.rate` (integer)
    Example: 9

  - `order.shipment.tax` (integer)

  - `order.shipment.total_paid` (integer)

  - `order.shipment.insured` (boolean)
    Example: true

  - `order.created_at` (string)
    The date and time when the store was created.

  - `order.updated_at` (string)
    The date and time when the store was last updated.

## Response 401 fields (application/json):

  - `message` (string)
    Example: "Unauthenticated."

## Response 409 fields (application/json):

  - `success` (boolean)
    Indicates whether the request was successful.

  - `errors` (array)
    An array of error messages.
    Example: ["Order already exists"]

## Response 422 fields (application/json):

  - `success` (boolean)

  - `errors` (array)
    Example: ["The data you entered is invalid"]

## Response 500 fields (application/json):

  - `success` (boolean)

  - `errors` (array)
    Example: ["An unknown error occured"]