API - Creating Orders

To create a new order in the system you'll need to use the /api/Order - PUT method

https://api.mintsoft.co.uk/swagger/ui/index#!/Order/Order_CreateOrder

The order will contain details about who it's being shipped to as well as the products that you want to ship.

Warehouse - Required

When creating an Order you'll need to specify the warehouse you want to create the order against. This can be done by name or ID

e.g.

WarehouseId: 3

or

Warehouse "Main Warehouse"

All full list of available warehouse can be found using the Get Warehouses api request:

https://api.mintsoft.co.uk/swagger/ui/index#!/Warehouse/Warehouse_GetWarehouses 

Country - Required

You'll need to specify the Country where the order is going to be shipped to. This can be done by Name or ID

e.g.

CountryId: 1

or

Country: "UK"

The country could be ISO 2 or 3 digit codes or country name e.g. 

All full list of countries can be found using the GetCountries api request:

https://api.mintsoft.co.uk/swagger/ui/index#!/RefData/RefData_Countries 

CourierService - Required

You'll need to specify how the order is going to be sent. This can be done as a generic term which can be mapped to rules or a specific courier id or name

e.g.

CourierServiceId: 12

or

CourierService: "NEXT DAY"

or

CourierService: "DPD NEXT DAY"

A full list of Courier services be be found using the GetCourierServices api request:

https://api.mintsoft.co.uk/swagger/ui/index#!/Courier/Courier_GetCourierServices

If you want to use shipping rules on the system instead then supply AUTO in the courier service

e.g.

CourierService: "AUTO"

Channel - Optional

When creating an Order you have option to specify a channel that the order came from. E.g. Website, Wholesale, Retail etc

This can be done by name or ID

e.g.

ChannelId: 1

or

Channel: "Retail Website"

Currency- Optional

When creating an Order you can specify the currency. e.g. GBP, USD etc

If not supplied will be defaulted to GBP

e.g.

Currency: "USD"

Order Items - Required

You'll need to specify a list of items that are on the Order.

When specifying the Product you can either specify the SKU or the exact ProductId

e.g.

SKU

"OrderItems": [{
 "SKU": "MY-PRODUCT_SKU",
 "Quantity": 1,
 "UnitPrice": 10,
 "UnitPriceVat": 2,
}]

or

"OrderItems": [{
 "ProductId": 1253,
 "Quantity": 1,
 "UnitPrice": 10,
 "UnitPriceVat": 2,
}]

 Full Example:

{
 "OrderItems": [{
 "SKU": "TEST-PRODUCT-1",
 "Quantity": 1,
 "UnitPrice": 10,
 "UnitPriceVat": 2
 }],
 "OrderNumber": "MY ORDER NUMBER",
 "ExternalOrderReference": "Additional Order Number",
 "Title": "MR",
 "CompanyName": "MY COMPANY NAME",
 "FirstName": "FIRST NAME",
 "LastName": "LAST NAME",
 "Address1": "First Line Address",
 "Address2": "Second Line Address",
 "Address3": "Third Line Address",
 "Town": "Town or City",
 "County": "County or State",
 "PostCode": "PostCode or ZipCode",
 "Country": "GB",
 "Email": "my@email.com",
 "Phone": "01245123456",
 "Mobile": "07979000000",
 "CourierService": "Next Day",
 "Warehouse": "Main Warehouse",
 "Currency": "GBP",
 "Comments": "Please pack in a safe box",
 "DeliveryNotes": "Delivery Message",
 "GiftMessages": "Gift Message",
 "OrderValue": 12
}