---
title: "CreateOrders"
method: POST
path: "/api/Orders/CreateOrders"
tags: ["Orders"]
---

# CreateOrders

`POST /api/Orders/CreateOrders`

## Request

- Base URL: `https://eu-ext.linnworks.net`
- URL: `https://eu-ext.linnworks.net/api/Orders/CreateOrders`
- Auth: API key in header `Authorization`

Creates new orders, once an order is paid it will be skipped on save. Returns list of pkOrderId's that were saved.
<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

## Request body

- OrdersCreateOrdersRequest
  - `orders` ChannelOrder[]: List of orders to create
    - `UseChannelTax` boolean: Validate if the tax should be overwritten on the order.
    - `pkOrderId` string, uuid: Used when IsNew is false to update the order
    - `AutomaticallyLinkBySKU` boolean: When the order is saved it will try and link by SKU after trying by channel sku mapping.
    - `AutomaticallyLinkByBarcode` boolean: When the order is saved it will try and link by Barcode after trying by channel sku mapping.
    - `AutomaticallyLinkByASIN` boolean: When the order is saved it will try and link by ASIN after trying by channel sku mapping.
    - `Site` string: Used to determine the site of the order.
    - `MatchPostalServiceTag` string: Match postal service method by name
    - `PostalServiceName` string: Postal service name used for saving new postal services
    - `SavePostalServiceIfNotExist` boolean: Determines wither or not to save postal service if it does not exist
    - `MatchPaymentMethodTag` string: Match payment method by name
    - `PaymentMethodName` string: Payment method name used for saving new payment methods
    - `SavePaymentMethodIfNotExist` boolean: Determines wither or not to save payment methods if it does not exist
    - `MappingSource` string: Overrides the mapping source for the channel for example if the Source is 'AMAZON FBA' MappingSource can be used to override to 'AMAZON'
    - `SourceOverride` string: Overrides the mapping source for the channel in the instance that the order may have originally been downloaded with an alternative source value.
    - `OrderState` 'None' | 'Hold' | 'Park': State the order should be saved e.g. hold, parked, none
    - `OrderFulfilmentType` 'Manual' | 'POS' | 'DigitalOnly' | 'FulfilmentByChannel': Defines type of fulfilment required for order
    - `OrderStatusType` 'Unknown' | 'Pending' | 'Unshipped' | 'PartiallyShipped' | 'Shipped' | 'PartiallyCancelled' | 'Cancelled' | 'PartiallyRefunded' | 'Refunded': The status of the order on the channel
    - `OrderStatus` string: The raw status text of the order on the channel
    - `PaymentStatus` 'Unpaid' | 'Paid' | 'Cancelled': Payment status of the order, eg Paid If Unpaid ChannelOrderAdapter.Save() will ensure order is PARKED
    - `OrderItems` ChannelOrderItem[]: List of order items
      - `TaxCostInclusive` boolean
      - `UseChannelTax` boolean: Validate if the tax should be overwritten on the order item.
      - `PricePerUnit` number, double: Individual price of the item
      - `PostalServiceCost` number, double: Postal service cost after discount
      - `Qty` integer: Quantity customer ordered
      - `TaxRate` number, double: Tax Rate as a whole number eg. 20
      - `LineDiscount` number, double: Discount percentage on the line as a whole number eg. 10
      - `LineRefund` number, double: The refund amount applied on the line, excluding shipping charges
      - `RefundQuantity` number, double: The quantity of items refunded (can be decimalised)
      - `ShippingRefund` number, double: The shipping refund for this line (if known)
      - `TotalRefund` number, double: The total refund amount applied on the line-level, including any shipping charges
      - `ItemNumber` string: Unique line number
      - `ChannelReferenceId` string: The item reference id on the channel
      - `ChannelSKU` string: SKU of the item ordered on the channel
      - `IsService` boolean: Indicates the item is a service and not a physical item
      - `ItemTitle` string: Title of the item ordered, or service name
      - `Options` ChannelOrderItemOption[]: Options on the item ordered
        - `Property` string
        - `Value` string
      - `Taxes` ChannelOrderItemTax[]
        - `TaxType` string
        - `TaxValue` number, double
        - `IsSellerCollected` boolean
    - `Refunds` ChannelOrderRefund[]: List of order refunds
      - `Reference` string: The refund id or reference on the channel.
      - `TransactionId` string: The transaction linked to the refund.
      - `IsOnline` boolean: Determines whether or not the transaction is linked to a real payment gateway.
      - `IsCancellation` boolean: Determines whether or not the refund is part of an order cancellation.
      - `Gateway` string: The payment gateway used.
      - `Currency` string: The three-letter code (ISO 4217) for the currency used for the refund.
      - `Items` ChannelOrderRefundItem[]: Any applicable items linked to the refund.
        - `ItemChannelReference` string: The product item's reference id on the channel.
        - `OrderItemNumber` string: The order item number linking to the order on the channel.
        - `LineAmount` number, double: The total amount refunded for the item.
        - `Quantity` number, double: The quantity refunded on the channel.
        - `QuantityWhole` integer: Rounded-down quantity of whole items refunded on the channel.
        - `ShippingAmount` number, double: Any shipping amount refunded against this item specifically.
        - `TotalAmount` number, double: The total amount refunded for the item and any shipping.
        - `ReasonCode` string: The refund reason code used from a pre-defined list of reasons
        - `ReasonText` string: The free-text refund reason
        - `PartialRefundReasonCode` string: The refund reason code used from a pre-defined list of reasons given for not refunding in full
        - `PartialRefundReasonText` string: The free-text refund reason given for not refunding in full
        - `InternalNote` string: A note intended for staff
      - `ItemsAmount` number, double: Any applicable money refunded for items.
      - `ShippingAmount` number, double: Any applicable shipping amount refunded.
      - `TotalAmount` number, double: The total amount of money refunded.
      - `ReasonCode` string: The refund reason code used from a pre-defined list of reasons
      - `ReasonText` string: The free-text refund reason
      - `PartialRefundReasonCode` string: The refund reason code used from a pre-defined list of reasons given for not refunding in full
      - `PartialRefundReasonText` string: The free-text refund reason given for not refunding in full
      - `InternalNote` string: A note intended for staff
    - `Locations` ChannelOrderLocation[]: The order location(s) on the channel
      - `ExternalReference` string: The order location id on the channel.
      - `ItemAllocations` ChannelOrderItemLocationAllocation[]: The item and quantity allocation. Only required if order is multi-location.
        - `ItemNumber` string
        - `Quantity` integer
    - `Relations` ChannelOrderId[]: Other orders that are related to this order. This iwll display a link in the order relations screen, allowing the user to identiy related orders.
      - `ReferenceId` string
      - `ExternalReference` string
      - `SecondaryReference` string
    - `ExtendedProperties` ChannelOrderExtendedProperty[]: List of extended properties for the order
      - `Name` string: Extended property name
      - `Value` string: Extended property value
      - `Type` string: Extended property type
    - `Notes` ChannelOrderNote[]: List of notes for the order
      - `Note` string: Order Note
      - `NoteEntryDate` string, date-time: Creation Date of the note
      - `NoteUserName` string: User who added the note
      - `Internal` boolean: Declares if the note is an internal note
    - `Source` string: Source
    - `SubSource` string: SubSource
    - `ChannelBuyerName` string: Channel buyer username / name
    - `ReferenceNumber` string: Reference number, should be the same as the one used for despatches
    - `ExternalReference` string: External Reference
    - `SecondaryReferenceNumber` string: Secondary reference number
    - `Currency` string: Currency of the order, if value is null, empty or white space it will default to UNK
    - `ConversionRate` number, double: The currency conversion rate Sale/Base
    - `ReceivedDate` string, date-time: UTC received date/time of the order
    - `UpdatedDate` string, date-time: UTC date/time the order was last updated at
    - `DispatchBy` string, date-time: UTC date/time the order should be despatched by
    - `PaidOn` string, date-time: Date the order was paid for
    - `PostalServiceCost` number, double: Postal service cost inclusive of tax after discount
    - `PostalServiceTaxRate` number, double: Tax percent for the postal service cost, eg 20
    - `PostalServiceDiscount` number, double: Discount percent for the postal service cost, this will not calculate down the postal service cost
    - `Discount` number, double: This represents the final discount applied to the order, as a value (not a percentage), after all item-level discounts are applied. It will be split evenly across all order items
    - `ItemsRefund` number, double: The refund amount applied across all items
    - `ShippingRefund` number, double: The amount refunded for shipping (if known)
    - `TotalRefund` number, double: The total refund amount applied to the order across all items, services and order-level refunds
    - `LineRefundAllocation` 'Unknown' | 'OrderLevel' | 'LineLevel' | 'Both': The known refund allocation for the order lines
    - `ShippingRefundAllocation` 'Unknown' | 'OrderLevel' | 'LineLevel' | 'Both': The known refund allocation for the order shipping
    - `BuyerTaxNumber` string: The tax number of the buyer
    - `DiscountType` 'AllEvenly' | 'ItemsThenPostage' | 'PostageThenItems': This represents how the discount will be split between items and postage. For an expsanation of each opiton, see the enum documentation
    - `DiscountTaxType` 'DeductAfterTax' | 'DeductBeforeTax': This represents if the discount is applied before or after tax
    - `BillingAddress` ChannelAddress
      - `MatchCountryCode` string
      - `MatchCountryName` string
      - `FullName` string: Customer name
      - `Company` string: Customer's company name
      - `Address1` string: 1st line of address
      - `Address2` string: 2nd line of address
      - `Address3` string: 3rd line of address
      - `Town` string: Town
      - `Region` string: Region, County, Area
      - `PostCode` string: Postcode
      - `Country` string: Country
      - `PhoneNumber` string: Customer's phone number
      - `EmailAddress` string: Customer's email address
      - `isEmpty` boolean: Check if the address is empty.
    - `DeliveryAddress` ChannelAddress
      - `MatchCountryCode` string
      - `MatchCountryName` string
      - `FullName` string: Customer name
      - `Company` string: Customer's company name
      - `Address1` string: 1st line of address
      - `Address2` string: 2nd line of address
      - `Address3` string: 3rd line of address
      - `Town` string: Town
      - `Region` string: Region, County, Area
      - `PostCode` string: Postcode
      - `Country` string: Country
      - `PhoneNumber` string: Customer's phone number
      - `EmailAddress` string: Customer's email address
      - `isEmpty` boolean: Check if the address is empty.
    - `DeliveryStartDate` string, date-time: Channel specified delivery start date (do not set where is not provided)
    - `DeliveryEndDate` string, date-time: Channel specified delivery end date (do not set where is not provided)
    - `OrderIdentifierTags` string[]: Order identifier tags
    - `ForceReSaveFulfilledOrder` boolean: Bool to re-save order
    - `PIIRedactionDays` integer: Days after order is processed when PII data will get redacted - NULL/Not Supplied will never redact
  - `location` string: Location to create the order

## Response `200`

OK

- string[]

---

[API](https://skmtc.dev/linnworks/apis/orders-api.md) - [All operations](https://skmtc.dev/linnworks/apis/orders-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linnworks/apis/orders-api/revisions/99d0cb3e4c9d?raw)