PUT orders/allocate-orders

This allows you to allocate stock locations to orders in bulk. You can only allocate a maximum of 50 orders at once. This method can only be used by accounts with multiple stock locations enabled.

Request Information

URI Parameters

None.

Body Parameters

This is a collection of the Orders to allocate.

Collection of OrderAllocationModel
NameDescriptionTypeAdditional information
OrderNumber The Order Number to allocate stock to. integer Required
ProductIDType The Product ID that you are using to perform this update ProductIDTypeModel Required
QuantityToAllocate The amount of stock that you want to allocate. integer Required
StockLocationToAllocate The Stock Location that you want to allocate stock to StockLocationProductIDTypeModel Required

Request Formats

application/json, text/json

Sample: 
[
  {
    "OrderNumber": 1,
    "ProductIDType": {
      "IDType": "SKU",
      "Value": "sample string 1"
    },
    "QuantityToAllocate": 2,
    "StockLocationToAllocate": {
      "IDType": "ID",
      "Value": "sample string 1",
      "Warehouse": {
        "IDType": "ID",
        "Value": "sample string 1"
      }
    }
  },
  {
    "OrderNumber": 1,
    "ProductIDType": {
      "IDType": "SKU",
      "Value": "sample string 1"
    },
    "QuantityToAllocate": 2,
    "StockLocationToAllocate": {
      "IDType": "ID",
      "Value": "sample string 1",
      "Warehouse": {
        "IDType": "ID",
        "Value": "sample string 1"
      }
    }
  }
]

Response Information

Resource Description

This allows you to allocate stock locations to orders in bulk. You can only allocate a maximum of 50 orders at once. This method can only be used by accounts with multiple stock locations enabled.

Collection of OrderAllocationResponse
NameDescriptionTypeAdditional information
OrderNumber The StoreFeeder Order number integer None.
ProductToAllocate The ProductID for Order line ProductIDTypeModel None.
StockLocationToAllocate The Stock LocationID allocated to StockLocationProductIDTypeModel None.
Success Whether the action was successful boolean None.
Error Any errors that were received Success will always be false if an error is returned. string None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "OrderNumber": 1,
    "ProductToAllocate": {
      "IDType": "SKU",
      "Value": "sample string 1"
    },
    "StockLocationToAllocate": {
      "IDType": "ID",
      "Value": "sample string 1",
      "Warehouse": {
        "IDType": "ID",
        "Value": "sample string 1"
      }
    },
    "Success": true,
    "Error": "sample string 3"
  },
  {
    "OrderNumber": 1,
    "ProductToAllocate": {
      "IDType": "SKU",
      "Value": "sample string 1"
    },
    "StockLocationToAllocate": {
      "IDType": "ID",
      "Value": "sample string 1",
      "Warehouse": {
        "IDType": "ID",
        "Value": "sample string 1"
      }
    },
    "Success": true,
    "Error": "sample string 3"
  }
]