---
title: "Create Order"
method: POST
path: "/order"
---

# Create Order

`POST /order`

## Query parameters

- `echo` boolean

## Request body

- object
  - `merchantId` integer
  - `lineItems` object[]
    - `id` integer
    - `name` string
    - `price` number, float
    - `quantity` string
    - `discountAmount` number, float
    - `totalAmount` number, float
    - `taxCategory` object[]
      - `id` string
      - `name` string
      - `code` string
      - `taxIds` string[]
      - `totalTax` string
      - `isPrimary` boolean
      - `primaryExists` boolean
      - `display` string
      - `taxRate` number, float
    - `initials` string
    - `taxes` object[]
      - `id` integer
      - `name` string
      - `description` string
      - `rate` string
      - `display` string
      - `taxCode` string
      - `taxCategoryId` integer
    - `amount` string
    - `taxAmount` string
    - `priceDiscountAmount` string
    - `taxRate` number, float
  - `shippingLineItems` object[]
    - `id` integer
    - `name` string
    - `price` number, float
    - `quantity` string
    - `discountAmount` number, float
    - `totalAmount` number, float
    - `taxCategory` object[]
      - `id` string
      - `name` string
      - `code` string
      - `taxIds` string[]
      - `totalTax` string
      - `isPrimary` boolean
      - `primaryExists` boolean
      - `display` string
      - `taxRate` number, float
    - `initials` string
    - `taxes` object[]
      - `id` integer
      - `name` string
      - `description` string
      - `rate` string
      - `display` string
      - `taxCode` string
      - `taxCategoryId` integer
    - `amount` string
    - `taxAmount` string
    - `priceDiscountAmount` string
    - `taxRate` number, float
  - `orderStatus` string — Values: Active, Completed, Draft, Cancelled
  - `sourceType` string — POS, Web, Telephone
  - `fulfillmentStatus` string
  - `paymentStatus` string
  - `orderedDate` string, date
  - `discounts` object[]
    - `amount` string
    - `code` string
    - `collections` string[]
    - `discountId` integer
    - `discountRateType` string
    - `discountType` string
    - `merchantId` integer
    - `name` string
    - `products` string[]
    - `rate` string
  - `totalAmount` string
  - `taxAmount` string
  - `balance` string
  - `subtotalAmount` string
  - `customerName` string
  - `customer` object
    - `id` integer
    - `name` string
    - `firstName` string
    - `lastName` string
    - `email` string
  - `customerId` string
  - `contactEmail` string
  - `notes` string
  - `shippedDate` string
  - `billingAddress` object
    - `address1` string
    - `address2` string
    - `isDefault` boolean
    - `state` string
    - `zip` string
  - `shippingAddress` object
    - `address1` string
    - `address2` string
    - `isDefault` boolean
    - `state` string
    - `zip` string
  - `lineItemCount` integer

## Response `201`

201

- object
  - `id` integer
  - `merchantId` integer
  - `created` string
  - `modified` string
  - `sourceType` string
  - `shippedDate` string
  - `reference` string
  - `accessCode` string
  - `orderStatus` string
  - `invoiceStatus` string
  - `paymentStatus` string
  - `packingStatus` string
  - `fulfillmentStatus` string
  - `returnStatus` string
  - `salesOrder` boolean
  - `deleted` boolean
  - `subtotalAmount` string
  - `discountAmount` string
  - `taxAmount` string
  - `totalAmount` string
  - `balance` string
  - `invoicedAmount` string
  - `paidAmount` string
  - `lineItemCount` integer
  - `saleQuantity` integer
  - `returnQuantity` integer
  - `netQuantity` integer
  - `invoiceQuantity` integer
  - `customerId` integer
  - `taxExempt` boolean
  - `customerName` string
  - `contactEmail` string
  - `billingAddress` object
  - `shippingAddress` object
  - `shippingIsSameAsBilling` boolean
  - `lineItems` object[]
    - `quantityReturned` string
    - `quantityInvoiced` string
    - `created` string
    - `modified` string
    - `id` integer
    - `position` integer
    - `name` string
    - `price` string
    - `discountRate` string
    - `discountAmount` string
    - `priceDiscountAmount` string
    - `taxRate` string
    - `taxAmount` string
    - `quantity` string
    - `amount` string
    - `discounts` object[]
    - `taxes` object[]
  - `shippingLineItems` object[]
  - `discounts` object[]
    - `id` integer
    - `discountRateType` string
    - `name` string
    - `rate` string
    - `amount` string
    - `code` string
    - `tags` object[]
    - `products` object[]
    - `collections` object[]
    - `discountId` integer
  - `orderNumber` integer
  - `barCode` string
  - `taxes` object[]

## Other responses

- `400` — 400

---

[API](https://skmtc.net/mxmerchant/apis/checkout-api.md) · [All operations](https://skmtc.net/mxmerchant/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mxmerchant/checkout-api/revisions/6807b698abcb/schema)