Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

Orders /AddOrderItem

Allows 250 calls per minute

Response: UpdateOrderItemResult



Add an item to a specific order.
Line pricing is optional with the default values being
- PricePerUnit: Stock item retail price
- DiscountPercentage: 0
- TaxRatePercentage: Stock item tax rate.
- TaxInclusive: true

Parameters

NameTypeDescription
orderIdGuidOrder id
itemIdGuidItem id to be added
channelSKUStringChannel SKU of the item
fulfilmentCenterGuidCurrent fulfilment center
quantityInt32Item quantity
linePricingLinePricingRequestItem pricing data

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Orders/AddOrderItem

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

orderId=9c8f54a7-d8a9-4fcd-a236-3520561b6c42&itemId=fafc4027-c5bd-4d25-81e0-05b8be30fc26&channelSKU=sample string 1&fulfilmentCenter=352fc55f-a43b-41ee-ad9c-1130394b8bfe&quantity=1&linePricing={
  "PricePerUnit": 1.1,
  "DiscountPercentage": 2.1,
  "TaxRatePercentage": 3.1,
  "TaxInclusive": true
}

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "TotalsInfo": {
    "Subtotal": 2.1,
    "PostageCost": 3.1,
    "Tax": 4.1,
    "TotalCharge": 5.1,
    "PaymentMethod": "sample string 6",
    "PaymentMethodId": "5b72d7c8-0a07-420c-9079-937f054da427",
    "ProfitMargin": 8.1,
    "TotalDiscount": 9.1,
    "Currency": "sample string 10",
    "CountryTaxRate": 11.1,
    "ConversionRate": 12.1
  },
  "Item": {
    "ItemId": "06e19859-937e-4a01-ba89-c4e8a202c3c1",
    "ItemNumber": "sample string 2",
    "SKU": "sample string 3",
    "ItemSource": "sample string 4",
    "Title": "sample string 5",
    "Quantity": 6,
    "CategoryName": "sample string 8",
    "CompositeAvailablity": 1,
    "StockLevelsSpecified": true,
    "OnOrder": 10,
    "OnPurchaseOrder": {
      "pkPurchaseItemId": "fcb623a2-5558-4007-9e95-6467a94bd9b4",
      "Rowid": "53cf90d5-2d95-4319-9118-3a7354be7a46",
      "pkPurchaseId": "fd1f1e8d-6755-49d5-9385-e782c0481559",
      "ExternalInvoiceNumber": "sample string 4",
      "fkSupplierId": "44170fe8-8d50-4f82-9349-5d768365c827",
      "DateOfDelivery": "2021-07-29T09:24:51.599857+01:00",
      "QuotedDeliveryDate": "2021-07-29T09:24:51.599857+01:00",
      "SupplierName": "sample string 8",
      "fkLocationId": "2c9f09a7-d33d-4f64-ac1e-8c3a6a4c5db4"
    },
    "InOrderBook": 1,
    "Level": 11,
    "MinimumLevel": 1,
    "AvailableStock": 12,
    "PricePerUnit": 13.1,
    "UnitCost": 14.1,
    "DespatchStockUnitCost": 15.1,
    "Discount": 16.1,
    "Tax": 21.1,
    "TaxRate": 17.1,
    "Cost": 18.1,
    "CostIncTax": 19.1,
    "CompositeSubItems": [
      {
      }
    ],
    "IsService": true,
    "SalesTax": 21.1,
    "TaxCostInclusive": true,
    "PartShipped": true,
    "Weight": 24.1,
    "BarcodeNumber": "sample string 25",
    "Market": 26,
    "ChannelSKU": "sample string 27",
    "ChannelTitle": "sample string 28",
    "DiscountValue": 10.806660973526899,
    "HasImage": true,
    "ImageId": "63f65a2d-7f16-4833-a98d-15a12b067584",
    "AdditionalInfo": [
      {
        "pkOptionId": "e6df7c6f-ed02-45ac-adc1-2016d67e6bd0",
        "Property": "sample string 2",
        "Value": "sample string 3"
      }
    ],
    "StockLevelIndicator": 29,
    "ShippingCost": 30.1,
    "PartShippedQty": 31,
    "ItemName": "sample string 32",
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "BinRack": "sample string 35",
    "BinRacks": [
      {
        "Quantity": 1,
        "BinRack": "sample string 2",
        "Location": "7af51d9f-e01d-4764-a50e-cdd461a20e18",
        "BatchId": 1,
        "OrderItemBatchId": 1
      }
    ],
    "InventoryTrackingType": 36,
    "isBatchedStockItem": false,
    "IsWarehouseManaged": true,
    "IsUnlinked": false,
    "StockItemIntId": 39,
    "Boxes": [
      {
        "BoxId": 1,
        "StockItemIntId": 2,
        "BoxName": "sample string 3",
        "Width": 4.0,
        "Height": 5.0,
        "Length": 6.0,
        "Weight": 7.0,
        "ValuePercentage": 8.0,
        "Barcode": "sample string 9",
        "PackagingTypeId": "2449dd54-e457-48e3-9927-1c7f194fc2f8",
        "LogicalDelete": true
      }
    ],
    "RowId": "37ca0de0-417b-4e0d-ac0f-1f15e8a2d609",
    "OrderId": "e3dcc71e-5ea1-412f-a4bc-5da838503705",
    "StockItemId": "b9ee3b2a-2ffa-46d9-a228-698e876329d5"
  },
  "ItemWeight": 1.1,
  "TotalWeight": 2.1
}