---
title: "Create Order Return"
method: POST
path: "/v3/orderreturn"
---

# Create Order Return

`POST /v3/orderreturn`

## Query parameters

- `id` integer, required
- `echo` boolean
- `includeCustomerMatches` boolean

## Request body

- object
  - `merchantId` integer, required
  - `totalAmount` number, float, required
  - `balance` number, float, required
  - `lineItemCount` integer, required
  - `lineItems` object[], required
    - `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[], required
    - `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
  - `payments` object[], required
    - `merchantId` integer
    - `tenderType` string
    - `amount` number, float
    - `type` string
    - `paymentToken` string

## Response `201`

201

- object
  - `id` integer
  - `merchantId` integer
  - `orderId` integer
  - `created` string
  - `modified` string
  - `totalAmount` string
  - `lineItemCount` integer
  - `balance` string
  - `lineItems` object[]
  - `shippingLineItems` object[]
  - `discounts` object[]
  - `payments` object[]
    - `created` string
    - `paymentToken` string
    - `originalId` integer
    - `id` integer
    - `isDuplicate` boolean
    - `merchantId` integer
    - `batchId` integer
    - `tenderType` string
    - `currency` string
    - `amount` string
    - `cardAccount` object
      - `cardType` string
      - `entryMode` string
      - `last4` string
      - `token` string
      - `expiryMonth` string
      - `expiryYear` string
      - `hasContract` boolean
      - `cardPresent` boolean
    - `posData` object
    - `authOnly` boolean
    - `authCode` string
    - `status` string
    - `risk` object
    - `customerMatches` object[]
      - `id` integer
      - `name` string
      - `number` string
      - `created` string
      - `modified` string
      - `loyaltyStatus` string
      - `loyaltyEnrolled` string
    - `settledAmount` string
    - `settledCurrency` string
    - `cardPresent` boolean
    - `authMessage` string
    - `reference` string
    - `invoice` string
    - `customerName` string
    - `type` string
    - `reviewIndicator` integer
    - `source` string
    - `shouldGetCreditCardLevel` boolean
  - `taxes` object[]
  - `adjustmentAmount` string

## Other responses

- `400` — 400

---

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