POST v1/Shops/{shopId}/Orders

Add a new Order.

Request Information

URI Parameters

Name	Description	Type	Additional information
shopId	The id of the shop to create the order for	integer	Required.

Body Parameters

The order data

OrderChanges

Name	Description	Type	Additional information
RecalculateTotalsOnSave	Gets or sets a value indicating whether we should recalculate the totals.	boolean	None.
SynchronizeOrderParameters	Gets or sets a value indicating whether we should synchronize the order parameters.	boolean	None.
AutoCreateCustomer	Gets or sets a value indicating whether a Customer must be created when not provided and can't be linked to an existing customer.	boolean	None.
Type	Gets or sets the order type identifier.	OrderTypeEnum	None.
OrderType	Gets or sets the preferred delivery date	OrderType	None.
PreferredDeliveryDate	Gets or sets the preferred delivery date	date	None.
MainStatus	Gets or sets the main status.	OrderStatus	None.
PaymentStatus	Gets or sets the payment status.	OrderStatus	None.
StockStatus	Gets or sets the stock status.	OrderStatus	None.
FulfilmentStatus	Gets or sets the Fulfilment status.	OrderStatus	None.
ShipmentStatus	Gets or sets the shipment status.	OrderStatus	None.
CustomStatus	Gets or sets the custom status.	OrderStatus	None.
CultureCode	Gets or sets the culture code. When adding/updating an Order, ShopCtrl will first try to find the Culture based on the provided CultureId. If not provided, the culture will be determined based on the provided CultureCode.	string	None.
CultureId	Gets or sets the culture identifier. When adding/updating an Order, ShopCtrl will first try to find the Culture based on the provided CultureId. If not provided, the culture will be determined based on the provided CultureCode.	integer	None.
Incoterms	Set the Incoterms for the Order.	IncotermsEnum	None.
ExchangeRate	Gets or sets the exchange rate.	decimal number	Required
ShopId	Gets or sets the shop identifier.	integer	Required
ViewModusIncVAT	Gets or sets a value indicating the view modus (the VAT is included).	boolean	Required
ExternalOrderKey	Gets or sets the external order key.	string	Max length: 50
CouponCode	Gets or sets the coupon code.	string	Max length: 50
PaymentFeeIncVat	Gets or sets the payment fee (include VAT).	decimal number	Required
PaymentFeeExVat	Gets or sets the payment fee (excluded VAT).	decimal number	Required
ShippingCostsIncVat	Gets or sets the shipping costs (include VAT).	decimal number	Required
ShippingCostsExVat	Gets or sets the shipping costs (exclude VAT).	decimal number	Required
PaymentTypeId	Gets or sets the payment type identifier.	integer	None.
PurchaseTypeId	Gets or sets the Purchase Type identifier.	integer	None.
CarrierAccountId	Gets or sets the Carrier Account identifier.	integer	None.
CustomerId	Gets or sets the customer identifier. When adding/updating an Order, ShopCtrl will first try to find the Customer based on the provided CustuomerId.	integer	None.
CustomerCode	Gets or sets the CustomerCode, as defined for the Customer. When adding/updating an Order, ShopCtrl will first try to find the Customer based on the provided CustuomerId. If not provided, the customer will be determined based on the provided CustomerCode.	string	None.
CustomerReference	Gets or sets the reference provided by the customer.	string	Max length: 100
CustomerNote	Gets or sets the customer note.	string	Max length: 2147483647
CustomerRating	This field is used for rating by the customer.	CustomerRatingValueEnum	Required
ShopNote	Gets or sets the shop note.	string	Max length: 2147483647
SyncSource	Gets or sets the synchronize source.	string	Max length: 50
CustomerIpaddress	Gets or sets the customer ipaddress.	string	Max length: 40
DiscountExVat	Gets or sets the discount (exclude VAT).	decimal number	Required
DiscountIncVat	Gets or sets the discount (include VAT).	decimal number	Required
BillToContact	Gets or sets the bill to contact.	ContactInfo	None.
ShipToContact	Gets or sets the ship to contact.	ContactInfo	None.
Params	Gets or sets the parameters.	Collection of Parameter	None.
OrderRows	Gets or sets the order rows.	Collection of OrderRow	None.
Shipments	Gets the order Shipment infos.	Collection of ShipmentBasicInfo	None.
Id	Gets or sets the identifier.	integer	Must be 0 (for insert operations)
OrderCode	Gets or sets the order code.	string	Required Max length: 50
Type	Gets the OrderTypeEnumValue.	OrderTypeEnum	None.
OrderTypeId	Gets the OrderTypeId.	integer	Required
Date	Gets or sets the date.	date	Required
OrderTotalIncVat	Gets or sets the order total with the 'VAT'.	decimal number	None.
OrderTotalExVat	Gets or sets the order total without the 'VAT'.	decimal number	Required
CurrencyId	Gets or sets the currency identifier.	integer	Required
CurrencyCode	Gets or sets the currency code.	string	None.
Deleted	Gets or sets a value indicating whether this <see cref="T:ShopCtrl.API.Models.OrderBase" /> is deleted.	boolean	Required
ChangeTimestamp	Gets or sets the change timestamp.	date	None.
MainStatusId	Gets or sets the main status identifier.	integer	None.
AffiliateId	Gets or sets the Affiliate identifier.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Shipments": [
    {
      "Id": 1,
      "ShippingCode": "sample string 2",
      "CreateTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ChangeTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShopId": 4,
      "OrderId": 5,
      "OrderCode": "sample string 6",
      "WarehouseId": 1,
      "ParcelId": 1,
      "PickedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "PackedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShippedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "HandOverTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShipmentType": 1
    },
    {
      "Id": 1,
      "ShippingCode": "sample string 2",
      "CreateTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ChangeTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShopId": 4,
      "OrderId": 5,
      "OrderCode": "sample string 6",
      "WarehouseId": 1,
      "ParcelId": 1,
      "PickedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "PackedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShippedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "HandOverTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShipmentType": 1
    }
  ],
  "RecalculateTotalsOnSave": true,
  "SynchronizeOrderParameters": true,
  "AutoCreateCustomer": true,
  "Type": 0,
  "OrderType": {
    "Id": 1,
    "Name": "sample string 2",
    "ShopOwnerId": 1,
    "Active": true,
    "FulfilmentPriority": 4,
    "OrderTypeEnumValue": 0
  },
  "PreferredDeliveryDate": "2026-01-11T16:15:39.4852846+01:00",
  "MainStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "PaymentStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "StockStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "FulfilmentStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "ShipmentStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "CustomStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "CultureCode": "sample string 4",
  "CultureId": 1,
  "Incoterms": 0,
  "ExchangeRate": 5.0,
  "ShopId": 6,
  "ViewModusIncVAT": true,
  "ExternalOrderKey": "sample string 8",
  "CouponCode": "sample string 9",
  "PaymentFeeIncVat": 10.0,
  "PaymentFeeExVat": 11.0,
  "ShippingCostsIncVat": 12.0,
  "ShippingCostsExVat": 13.0,
  "PaymentTypeId": 1,
  "PurchaseTypeId": 14,
  "CarrierAccountId": 1,
  "CustomerId": 1,
  "CustomerCode": "sample string 15",
  "CustomerReference": "sample string 16",
  "CustomerNote": "sample string 17",
  "CustomerRating": 0,
  "ShopNote": "sample string 18",
  "SyncSource": "sample string 19",
  "CustomerIpaddress": "sample string 20",
  "DiscountExVat": 21.0,
  "DiscountIncVat": 22.0,
  "BillToContact": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2026-01-11T16:15:39.4852846+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "ShipToContact": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2026-01-11T16:15:39.4852846+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "Params": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    }
  ],
  "OrderRows": [
    {
      "Id": 1,
      "ProductSelectionProductId": 1,
      "ProductId": null,
      "OrderRowKey": "sample string 2",
      "ItemQuantity": 3.0,
      "ProductName": "sample string 4",
      "ProductCode": "sample string 5",
      "ProductDescription": "sample string 6",
      "ItemPriceExVat": 7.0,
      "ItemPriceIncVat": 8.0,
      "ItemDiscountExVat": 9.0,
      "ItemDiscountIncVat": 10.0,
      "RowDiscountExVat": 11.0,
      "RowDiscountIncVat": 12.0,
      "Vatperc": 1.0,
      "VATTariffId": 1,
      "VATTariffCode": "sample string 13",
      "RowTotalExVat": 14.0,
      "RowTotalIncVat": 15.0,
      "Comment": "sample string 16",
      "SupplierId": 1,
      "ItemPurchasePrice": 1.0,
      "CreditForOrderRowId": 1,
      "Sequence": 1,
      "ShopProductUrl": "sample string 17",
      "ShopProductImageUrl": "sample string 18",
      "ShipmentId": 1,
      "StockStatus": 0,
      "IsAllocated": true,
      "WarehouseId": 1,
      "WarehouseSelectionMethod": 0,
      "Params": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "DataType": 0,
          "DataTypeName": "String"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "DataType": 0,
          "DataTypeName": "String"
        }
      ],
      "DisableRecalculate": true
    },
    {
      "Id": 1,
      "ProductSelectionProductId": 1,
      "ProductId": null,
      "OrderRowKey": "sample string 2",
      "ItemQuantity": 3.0,
      "ProductName": "sample string 4",
      "ProductCode": "sample string 5",
      "ProductDescription": "sample string 6",
      "ItemPriceExVat": 7.0,
      "ItemPriceIncVat": 8.0,
      "ItemDiscountExVat": 9.0,
      "ItemDiscountIncVat": 10.0,
      "RowDiscountExVat": 11.0,
      "RowDiscountIncVat": 12.0,
      "Vatperc": 1.0,
      "VATTariffId": 1,
      "VATTariffCode": "sample string 13",
      "RowTotalExVat": 14.0,
      "RowTotalIncVat": 15.0,
      "Comment": "sample string 16",
      "SupplierId": 1,
      "ItemPurchasePrice": 1.0,
      "CreditForOrderRowId": 1,
      "Sequence": 1,
      "ShopProductUrl": "sample string 17",
      "ShopProductImageUrl": "sample string 18",
      "ShipmentId": 1,
      "StockStatus": 0,
      "IsAllocated": true,
      "WarehouseId": 1,
      "WarehouseSelectionMethod": 0,
      "Params": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "DataType": 0,
          "DataTypeName": "String"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "DataType": 0,
          "DataTypeName": "String"
        }
      ],
      "DisableRecalculate": true
    }
  ],
  "Id": 23,
  "OrderCode": "sample string 24",
  "OrderTypeId": 25,
  "Date": "2026-01-11T16:15:39.4852846+01:00",
  "OrderTotalIncVat": 27.0,
  "OrderTotalExVat": 28.0,
  "CurrencyId": 29,
  "CurrencyCode": "sample string 30",
  "Deleted": true,
  "ChangeTimestamp": "2026-01-11T16:15:39.4852846+01:00",
  "MainStatusId": 1,
  "AffiliateId": 1
}

application/xml, text/xml

Sample:

<OrderChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>23</Id>
  <OrderCode>sample string 24</OrderCode>
  <OrderTypeId>25</OrderTypeId>
  <Date>2026-01-11T16:15:39.4852846+01:00</Date>
  <OrderTotalIncVat>27</OrderTotalIncVat>
  <OrderTotalExVat>28</OrderTotalExVat>
  <CurrencyId>29</CurrencyId>
  <CurrencyCode>sample string 30</CurrencyCode>
  <Deleted>true</Deleted>
  <ChangeTimestamp>2026-01-11T16:15:39.4852846+01:00</ChangeTimestamp>
  <MainStatusId>1</MainStatusId>
  <AffiliateId>1</AffiliateId>
  <OrderType>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <ShopOwnerId>1</ShopOwnerId>
    <Active>true</Active>
    <FulfilmentPriority>4</FulfilmentPriority>
    <OrderTypeEnumValue>SalesOrder</OrderTypeEnumValue>
  </OrderType>
  <PreferredDeliveryDate>2026-01-11T16:15:39.4852846+01:00</PreferredDeliveryDate>
  <MainStatus>
    <Id>2</Id>
    <BaseOrderStatusId>3</BaseOrderStatusId>
    <OrderStatusTypeId>4</OrderStatusTypeId>
    <Name>sample string 5</Name>
    <Enabled>true</Enabled>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:15:39.4852846+01:00</ActionDate>
  </MainStatus>
  <PaymentStatus>
    <Id>2</Id>
    <BaseOrderStatusId>3</BaseOrderStatusId>
    <OrderStatusTypeId>4</OrderStatusTypeId>
    <Name>sample string 5</Name>
    <Enabled>true</Enabled>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:15:39.4852846+01:00</ActionDate>
  </PaymentStatus>
  <StockStatus>
    <Id>2</Id>
    <BaseOrderStatusId>3</BaseOrderStatusId>
    <OrderStatusTypeId>4</OrderStatusTypeId>
    <Name>sample string 5</Name>
    <Enabled>true</Enabled>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:15:39.4852846+01:00</ActionDate>
  </StockStatus>
  <FulfilmentStatus>
    <Id>2</Id>
    <BaseOrderStatusId>3</BaseOrderStatusId>
    <OrderStatusTypeId>4</OrderStatusTypeId>
    <Name>sample string 5</Name>
    <Enabled>true</Enabled>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:15:39.4852846+01:00</ActionDate>
  </FulfilmentStatus>
  <ShipmentStatus>
    <Id>2</Id>
    <BaseOrderStatusId>3</BaseOrderStatusId>
    <OrderStatusTypeId>4</OrderStatusTypeId>
    <Name>sample string 5</Name>
    <Enabled>true</Enabled>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:15:39.4852846+01:00</ActionDate>
  </ShipmentStatus>
  <CustomStatus>
    <Id>2</Id>
    <BaseOrderStatusId>3</BaseOrderStatusId>
    <OrderStatusTypeId>4</OrderStatusTypeId>
    <Name>sample string 5</Name>
    <Enabled>true</Enabled>
    <Comment>sample string 1</Comment>
    <ActionDate>2026-01-11T16:15:39.4852846+01:00</ActionDate>
  </CustomStatus>
  <CultureCode>sample string 4</CultureCode>
  <CultureId>1</CultureId>
  <Incoterms>EXW</Incoterms>
  <ExchangeRate>5</ExchangeRate>
  <ShopId>6</ShopId>
  <ViewModusIncVAT>true</ViewModusIncVAT>
  <ExternalOrderKey>sample string 8</ExternalOrderKey>
  <CouponCode>sample string 9</CouponCode>
  <PaymentFeeIncVat>10</PaymentFeeIncVat>
  <PaymentFeeExVat>11</PaymentFeeExVat>
  <ShippingCostsIncVat>12</ShippingCostsIncVat>
  <ShippingCostsExVat>13</ShippingCostsExVat>
  <PaymentTypeId>1</PaymentTypeId>
  <PurchaseTypeId>14</PurchaseTypeId>
  <CarrierAccountId>1</CarrierAccountId>
  <CustomerId>1</CustomerId>
  <CustomerCode>sample string 15</CustomerCode>
  <CustomerReference>sample string 16</CustomerReference>
  <CustomerNote>sample string 17</CustomerNote>
  <CustomerRating>Rated0Stars</CustomerRating>
  <ShopNote>sample string 18</ShopNote>
  <SyncSource>sample string 19</SyncSource>
  <CustomerIpaddress>sample string 20</CustomerIpaddress>
  <DiscountExVat>21</DiscountExVat>
  <DiscountIncVat>22</DiscountIncVat>
  <BillToContact>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2026-01-11T16:15:39.4852846+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </BillToContact>
  <ShipToContact>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2026-01-11T16:15:39.4852846+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </ShipToContact>
  <Params>
    <OrderParameter>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>String</DataType>
    </OrderParameter>
    <OrderParameter>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>String</DataType>
    </OrderParameter>
  </Params>
  <OrderRows>
    <OrderRow>
      <Id>1</Id>
      <ProductSelectionProductId>1</ProductSelectionProductId>
      <OrderRowKey>sample string 2</OrderRowKey>
      <ItemQuantity>3</ItemQuantity>
      <ProductName>sample string 4</ProductName>
      <ProductCode>sample string 5</ProductCode>
      <ProductDescription>sample string 6</ProductDescription>
      <ItemPriceExVat>7</ItemPriceExVat>
      <ItemPriceIncVat>8</ItemPriceIncVat>
      <ItemDiscountExVat>9</ItemDiscountExVat>
      <ItemDiscountIncVat>10</ItemDiscountIncVat>
      <RowDiscountExVat>11</RowDiscountExVat>
      <RowDiscountIncVat>12</RowDiscountIncVat>
      <Vatperc>1</Vatperc>
      <VATTariffId>1</VATTariffId>
      <VATTariffCode>sample string 13</VATTariffCode>
      <RowTotalExVat>14</RowTotalExVat>
      <RowTotalIncVat>15</RowTotalIncVat>
      <Comment>sample string 16</Comment>
      <SupplierId>1</SupplierId>
      <ItemPurchasePrice>1</ItemPurchasePrice>
      <CreditForOrderRowId>1</CreditForOrderRowId>
      <Sequence>1</Sequence>
      <ShopProductUrl>sample string 17</ShopProductUrl>
      <ShopProductImageUrl>sample string 18</ShopProductImageUrl>
      <ShipmentId>1</ShipmentId>
      <StockStatus>NotActive</StockStatus>
      <IsAllocated>true</IsAllocated>
      <WarehouseId>1</WarehouseId>
      <WarehouseSelectionMethod>Automatic</WarehouseSelectionMethod>
      <Params>
        <Param>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
          <DataType>String</DataType>
        </Param>
        <Param>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
          <DataType>String</DataType>
        </Param>
      </Params>
      <DisableRecalculate>true</DisableRecalculate>
    </OrderRow>
    <OrderRow>
      <Id>1</Id>
      <ProductSelectionProductId>1</ProductSelectionProductId>
      <OrderRowKey>sample string 2</OrderRowKey>
      <ItemQuantity>3</ItemQuantity>
      <ProductName>sample string 4</ProductName>
      <ProductCode>sample string 5</ProductCode>
      <ProductDescription>sample string 6</ProductDescription>
      <ItemPriceExVat>7</ItemPriceExVat>
      <ItemPriceIncVat>8</ItemPriceIncVat>
      <ItemDiscountExVat>9</ItemDiscountExVat>
      <ItemDiscountIncVat>10</ItemDiscountIncVat>
      <RowDiscountExVat>11</RowDiscountExVat>
      <RowDiscountIncVat>12</RowDiscountIncVat>
      <Vatperc>1</Vatperc>
      <VATTariffId>1</VATTariffId>
      <VATTariffCode>sample string 13</VATTariffCode>
      <RowTotalExVat>14</RowTotalExVat>
      <RowTotalIncVat>15</RowTotalIncVat>
      <Comment>sample string 16</Comment>
      <SupplierId>1</SupplierId>
      <ItemPurchasePrice>1</ItemPurchasePrice>
      <CreditForOrderRowId>1</CreditForOrderRowId>
      <Sequence>1</Sequence>
      <ShopProductUrl>sample string 17</ShopProductUrl>
      <ShopProductImageUrl>sample string 18</ShopProductImageUrl>
      <ShipmentId>1</ShipmentId>
      <StockStatus>NotActive</StockStatus>
      <IsAllocated>true</IsAllocated>
      <WarehouseId>1</WarehouseId>
      <WarehouseSelectionMethod>Automatic</WarehouseSelectionMethod>
      <Params>
        <Param>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
          <DataType>String</DataType>
        </Param>
        <Param>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
          <DataType>String</DataType>
        </Param>
      </Params>
      <DisableRecalculate>true</DisableRecalculate>
    </OrderRow>
  </OrderRows>
  <RecalculateTotalsOnSave>true</RecalculateTotalsOnSave>
  <SynchronizeOrderParameters>true</SynchronizeOrderParameters>
  <AutoCreateCustomer>true</AutoCreateCustomer>
  <Type>SalesOrder</Type>
</OrderChanges>

Response Information

Resource Description

The Order object.

Order

Name	Description	Type	Additional information
OrderType	Gets or sets the preferred delivery date	OrderType	None.
PreferredDeliveryDate	Gets or sets the preferred delivery date	date	None.
MainStatus	Gets or sets the main status.	OrderStatus	None.
PaymentStatus	Gets or sets the payment status.	OrderStatus	None.
StockStatus	Gets or sets the stock status.	OrderStatus	None.
FulfilmentStatus	Gets or sets the Fulfilment status.	OrderStatus	None.
ShipmentStatus	Gets or sets the shipment status.	OrderStatus	None.
CustomStatus	Gets or sets the custom status.	OrderStatus	None.
CultureCode	Gets or sets the culture code. When adding/updating an Order, ShopCtrl will first try to find the Culture based on the provided CultureId. If not provided, the culture will be determined based on the provided CultureCode.	string	None.
CultureId	Gets or sets the culture identifier. When adding/updating an Order, ShopCtrl will first try to find the Culture based on the provided CultureId. If not provided, the culture will be determined based on the provided CultureCode.	integer	None.
Incoterms	Set the Incoterms for the Order.	IncotermsEnum	None.
ExchangeRate	Gets or sets the exchange rate.	decimal number	Required
ShopId	Gets or sets the shop identifier.	integer	Required
ViewModusIncVAT	Gets or sets a value indicating the view modus (the VAT is included).	boolean	Required
ExternalOrderKey	Gets or sets the external order key.	string	Max length: 50
CouponCode	Gets or sets the coupon code.	string	Max length: 50
PaymentFeeIncVat	Gets or sets the payment fee (include VAT).	decimal number	Required
PaymentFeeExVat	Gets or sets the payment fee (excluded VAT).	decimal number	Required
ShippingCostsIncVat	Gets or sets the shipping costs (include VAT).	decimal number	Required
ShippingCostsExVat	Gets or sets the shipping costs (exclude VAT).	decimal number	Required
PaymentTypeId	Gets or sets the payment type identifier.	integer	None.
PurchaseTypeId	Gets or sets the Purchase Type identifier.	integer	None.
CarrierAccountId	Gets or sets the Carrier Account identifier.	integer	None.
CustomerId	Gets or sets the customer identifier. When adding/updating an Order, ShopCtrl will first try to find the Customer based on the provided CustuomerId.	integer	None.
CustomerCode	Gets or sets the CustomerCode, as defined for the Customer. When adding/updating an Order, ShopCtrl will first try to find the Customer based on the provided CustuomerId. If not provided, the customer will be determined based on the provided CustomerCode.	string	None.
CustomerReference	Gets or sets the reference provided by the customer.	string	Max length: 100
CustomerNote	Gets or sets the customer note.	string	Max length: 2147483647
CustomerRating	This field is used for rating by the customer.	CustomerRatingValueEnum	Required
ShopNote	Gets or sets the shop note.	string	Max length: 2147483647
SyncSource	Gets or sets the synchronize source.	string	Max length: 50
CustomerIpaddress	Gets or sets the customer ipaddress.	string	Max length: 40
DiscountExVat	Gets or sets the discount (exclude VAT).	decimal number	Required
DiscountIncVat	Gets or sets the discount (include VAT).	decimal number	Required
BillToContact	Gets or sets the bill to contact.	ContactInfo	None.
ShipToContact	Gets or sets the ship to contact.	ContactInfo	None.
Params	Gets or sets the parameters.	Collection of Parameter	None.
OrderRows	Gets or sets the order rows.	Collection of OrderRow	None.
Parcels	Gets the order Parcel infos.	Collection of ParcelBasicInfo	None.
Shipments	Gets the order Shipment infos.	Collection of ShipmentBasicInfo	None.
Id	Gets or sets the identifier.	integer	Must be 0 (for insert operations)
OrderCode	Gets or sets the order code.	string	Required Max length: 50
Type	Gets the OrderTypeEnumValue.	OrderTypeEnum	None.
OrderTypeId	Gets the OrderTypeId.	integer	Required
Date	Gets or sets the date.	date	Required
OrderTotalIncVat	Gets or sets the order total with the 'VAT'.	decimal number	None.
OrderTotalExVat	Gets or sets the order total without the 'VAT'.	decimal number	Required
CurrencyId	Gets or sets the currency identifier.	integer	Required
CurrencyCode	Gets or sets the currency code.	string	None.
Deleted	Gets or sets a value indicating whether this <see cref="T:ShopCtrl.API.Models.OrderBase" /> is deleted.	boolean	Required
ChangeTimestamp	Gets or sets the change timestamp.	date	None.
MainStatusId	Gets or sets the main status identifier.	integer	None.
AffiliateId	Gets or sets the Affiliate identifier.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderType": {
    "Id": 1,
    "Name": "sample string 2",
    "ShopOwnerId": 1,
    "Active": true,
    "FulfilmentPriority": 4,
    "OrderTypeEnumValue": 0
  },
  "PreferredDeliveryDate": "2026-01-11T16:15:39.4852846+01:00",
  "MainStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "PaymentStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "StockStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "FulfilmentStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "ShipmentStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "CustomStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2026-01-11T16:15:39.4852846+01:00",
    "Id": 2,
    "BaseOrderStatusId": 3,
    "OrderStatusTypeId": 4,
    "Name": "sample string 5",
    "Enabled": true
  },
  "CultureCode": "sample string 1",
  "CultureId": 1,
  "Incoterms": 0,
  "ExchangeRate": 2.0,
  "ShopId": 3,
  "ViewModusIncVAT": true,
  "ExternalOrderKey": "sample string 5",
  "CouponCode": "sample string 6",
  "PaymentFeeIncVat": 7.0,
  "PaymentFeeExVat": 8.0,
  "ShippingCostsIncVat": 9.0,
  "ShippingCostsExVat": 10.0,
  "PaymentTypeId": 1,
  "PurchaseTypeId": 11,
  "CarrierAccountId": 1,
  "CustomerId": 1,
  "CustomerCode": "sample string 12",
  "CustomerReference": "sample string 13",
  "CustomerNote": "sample string 14",
  "CustomerRating": 0,
  "ShopNote": "sample string 15",
  "SyncSource": "sample string 16",
  "CustomerIpaddress": "sample string 17",
  "DiscountExVat": 18.0,
  "DiscountIncVat": 19.0,
  "BillToContact": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2026-01-11T16:15:39.4852846+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "ShipToContact": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2026-01-11T16:15:39.4852846+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "Params": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    }
  ],
  "OrderRows": [
    {
      "Id": 1,
      "ProductSelectionProductId": 1,
      "ProductId": null,
      "OrderRowKey": "sample string 2",
      "ItemQuantity": 3.0,
      "ProductName": "sample string 4",
      "ProductCode": "sample string 5",
      "ProductDescription": "sample string 6",
      "ItemPriceExVat": 7.0,
      "ItemPriceIncVat": 8.0,
      "ItemDiscountExVat": 9.0,
      "ItemDiscountIncVat": 10.0,
      "RowDiscountExVat": 11.0,
      "RowDiscountIncVat": 12.0,
      "Vatperc": 1.0,
      "VATTariffId": 1,
      "VATTariffCode": "sample string 13",
      "RowTotalExVat": 14.0,
      "RowTotalIncVat": 15.0,
      "Comment": "sample string 16",
      "SupplierId": 1,
      "ItemPurchasePrice": 1.0,
      "CreditForOrderRowId": 1,
      "Sequence": 1,
      "ShopProductUrl": "sample string 17",
      "ShopProductImageUrl": "sample string 18",
      "ShipmentId": 1,
      "StockStatus": 0,
      "IsAllocated": true,
      "WarehouseId": 1,
      "WarehouseSelectionMethod": 0,
      "Params": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "DataType": 0,
          "DataTypeName": "String"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "DataType": 0,
          "DataTypeName": "String"
        }
      ],
      "DisableRecalculate": true
    },
    {
      "Id": 1,
      "ProductSelectionProductId": 1,
      "ProductId": null,
      "OrderRowKey": "sample string 2",
      "ItemQuantity": 3.0,
      "ProductName": "sample string 4",
      "ProductCode": "sample string 5",
      "ProductDescription": "sample string 6",
      "ItemPriceExVat": 7.0,
      "ItemPriceIncVat": 8.0,
      "ItemDiscountExVat": 9.0,
      "ItemDiscountIncVat": 10.0,
      "RowDiscountExVat": 11.0,
      "RowDiscountIncVat": 12.0,
      "Vatperc": 1.0,
      "VATTariffId": 1,
      "VATTariffCode": "sample string 13",
      "RowTotalExVat": 14.0,
      "RowTotalIncVat": 15.0,
      "Comment": "sample string 16",
      "SupplierId": 1,
      "ItemPurchasePrice": 1.0,
      "CreditForOrderRowId": 1,
      "Sequence": 1,
      "ShopProductUrl": "sample string 17",
      "ShopProductImageUrl": "sample string 18",
      "ShipmentId": 1,
      "StockStatus": 0,
      "IsAllocated": true,
      "WarehouseId": 1,
      "WarehouseSelectionMethod": 0,
      "Params": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "DataType": 0,
          "DataTypeName": "String"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "DataType": 0,
          "DataTypeName": "String"
        }
      ],
      "DisableRecalculate": true
    }
  ],
  "Parcels": [
    {
      "Id": 1,
      "TrackingCode": "sample string 2",
      "TrackingUrl": "sample string 3",
      "CreateTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ChangedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "CarrierName": "sample string 6",
      "ShopId": 7,
      "OrderId": 1,
      "CarrierAccountId": 8,
      "OrderShipmentId": 1,
      "ParcelStatus": 1,
      "IsReturn": true,
      "ErrorMessage": "sample string 10"
    },
    {
      "Id": 1,
      "TrackingCode": "sample string 2",
      "TrackingUrl": "sample string 3",
      "CreateTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ChangedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "CarrierName": "sample string 6",
      "ShopId": 7,
      "OrderId": 1,
      "CarrierAccountId": 8,
      "OrderShipmentId": 1,
      "ParcelStatus": 1,
      "IsReturn": true,
      "ErrorMessage": "sample string 10"
    }
  ],
  "Shipments": [
    {
      "Id": 1,
      "ShippingCode": "sample string 2",
      "CreateTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ChangeTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShopId": 4,
      "OrderId": 5,
      "OrderCode": "sample string 6",
      "WarehouseId": 1,
      "ParcelId": 1,
      "PickedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "PackedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShippedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "HandOverTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShipmentType": 1
    },
    {
      "Id": 1,
      "ShippingCode": "sample string 2",
      "CreateTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ChangeTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShopId": 4,
      "OrderId": 5,
      "OrderCode": "sample string 6",
      "WarehouseId": 1,
      "ParcelId": 1,
      "PickedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "PackedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShippedTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "HandOverTimestamp": "2026-01-11T16:15:39.4852846+01:00",
      "ShipmentType": 1
    }
  ],
  "Id": 20,
  "OrderCode": "sample string 21",
  "Type": 0,
  "OrderTypeId": 22,
  "Date": "2026-01-11T16:15:39.4852846+01:00",
  "OrderTotalIncVat": 24.0,
  "OrderTotalExVat": 25.0,
  "CurrencyId": 26,
  "CurrencyCode": "sample string 27",
  "Deleted": true,
  "ChangeTimestamp": "2026-01-11T16:15:39.4852846+01:00",
  "MainStatusId": 1,
  "AffiliateId": 1
}