POST api/v1/Orders

Post a template order for a member.

Request Information

URI Parameters

Body Parameters

Name	Description	Type
Id		integer
ShortOrderNumber	Short order number for the order. System generated	string
ClientId	Client ID for the order	integer
MemberId	Member ID for the order	integer
OrderTypeId	Order Type ID for the order	TOrderType
DisplayOrderType		string
DisplayOrderStatus		string
OrderSourceId	Order Type ID for the order	TOrderSource
OrderStatusId	Order Status ID for the order	TOrderStatus
OrderDate	Order Date for the order	date
OrderTemplateId	Not required for all orders. If you supply it, please make it accurate	integer
ShipName	Shipping name for the order	string
ShipAddress1	Shipping address line 1 for the order	string
ShipAddress2	Shipping address line 2 for the order	string
ShipAddress3	Shipping address line 3 for the order	string
ShipCity	Shipping city for the order	string
ShipState	Shipping state for the order	string
ShipZip	Shipping zip code for the order	string
ShipPhone	Shipping phone number for the order	string
Email	Email address for the order	string
ShippingServiceLevel	Shipping service level for the order	string
PreferredShipMethod	Preferred shipping method for the order	string
PackslipMessage	Packslip message for the order	string
MustShipByDate	Must ship by date for the order	date
OrderItems	Collection of order items	Collection of OrderItem
OrderShipments	Collection of order shipments	Collection of OrderShipment
Client	Client associated with the order	Client
ExecutionTime	How long the method took in milliseconds. System supplied value.	integer
TxID	Transaction ID of the call. Will be added for the response. Not needed in the request.	string

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "shortOrderNumber": "sample string 3",
  "clientId": 4,
  "memberId": 5,
  "orderTypeId": "Unknown",
  "displayOrderType": "sample string 6",
  "displayOrderStatus": "sample string 7",
  "orderSourceId": "Unknown",
  "orderStatusId": "Unknown",
  "orderDate": "2025-12-19T20:17:43.5928446+00:00",
  "orderTemplateId": 1,
  "shipName": "sample string 9",
  "shipAddress1": "sample string 10",
  "shipAddress2": "sample string 11",
  "shipAddress3": "sample string 12",
  "shipCity": "sample string 13",
  "shipState": "sample string 14",
  "shipZip": "sample string 15",
  "shipPhone": "sample string 16",
  "email": "sample string 17",
  "shippingServiceLevel": "sample string 18",
  "preferredShipMethod": "sample string 19",
  "packslipMessage": "sample string 20",
  "mustShipByDate": "2025-12-19T20:17:43.5928446+00:00",
  "orderItems": [
    {
      "itemCode": "sample string 4",
      "quantity": 5,
      "item": {
        "$id": "1",
        "executionTime": 28,
        "txID": "sample string 29"
      },
      "executionTime": 8,
      "txID": "sample string 9"
    },
    {
      "itemCode": "sample string 4",
      "quantity": 5,
      "item": {
        "$ref": "1"
      },
      "executionTime": 8,
      "txID": "sample string 9"
    }
  ],
  "orderShipments": [
    {
      "id": 1,
      "orderId": 2,
      "shortOrderNumber": "sample string 3",
      "orderShipmentDate": "2025-12-19T20:17:43.5928446+00:00",
      "orderShipmentPackageNumber": 5,
      "orderShipmentStatusId": "Unknown",
      "warehouseId": 6,
      "shipName": "sample string 7",
      "shipAddress1": "sample string 8",
      "shipAddress2": "sample string 9",
      "shipAddress3": "sample string 10",
      "shipCity": "sample string 11",
      "shipState": "sample string 12",
      "shipZip": "sample string 13",
      "shipPhone": "sample string 14",
      "weight": 15.0,
      "orderShipmentItems": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-12-19T20:17:43.5928446+00:00",
          "kitBuildBarcode": "sample string 7",
          "executionTime": 10,
          "txID": "sample string 11"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-12-19T20:17:43.5928446+00:00",
          "kitBuildBarcode": "sample string 7",
          "executionTime": 10,
          "txID": "sample string 11"
        }
      ],
      "orderShipmentPackages": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "trackingLink": "sample string 7",
          "deliveryStatus": "sample string 8",
          "carrierReceiveDate": "2025-12-19T20:17:43.5928446+00:00",
          "transitDays": 10.0,
          "deliveryDate": "2025-12-19T20:17:43.5928446+00:00",
          "executionTime": 14,
          "txID": "sample string 15"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "trackingLink": "sample string 7",
          "deliveryStatus": "sample string 8",
          "carrierReceiveDate": "2025-12-19T20:17:43.5928446+00:00",
          "transitDays": 10.0,
          "deliveryDate": "2025-12-19T20:17:43.5928446+00:00",
          "executionTime": 14,
          "txID": "sample string 15"
        }
      ],
      "executionTime": 18,
      "txID": "sample string 19"
    },
    {
      "id": 1,
      "orderId": 2,
      "shortOrderNumber": "sample string 3",
      "orderShipmentDate": "2025-12-19T20:17:43.5928446+00:00",
      "orderShipmentPackageNumber": 5,
      "orderShipmentStatusId": "Unknown",
      "warehouseId": 6,
      "shipName": "sample string 7",
      "shipAddress1": "sample string 8",
      "shipAddress2": "sample string 9",
      "shipAddress3": "sample string 10",
      "shipCity": "sample string 11",
      "shipState": "sample string 12",
      "shipZip": "sample string 13",
      "shipPhone": "sample string 14",
      "weight": 15.0,
      "orderShipmentItems": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-12-19T20:17:43.5928446+00:00",
          "kitBuildBarcode": "sample string 7",
          "executionTime": 10,
          "txID": "sample string 11"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-12-19T20:17:43.5928446+00:00",
          "kitBuildBarcode": "sample string 7",
          "executionTime": 10,
          "txID": "sample string 11"
        }
      ],
      "orderShipmentPackages": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "trackingLink": "sample string 7",
          "deliveryStatus": "sample string 8",
          "carrierReceiveDate": "2025-12-19T20:17:43.5928446+00:00",
          "transitDays": 10.0,
          "deliveryDate": "2025-12-19T20:17:43.5928446+00:00",
          "executionTime": 14,
          "txID": "sample string 15"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "trackingLink": "sample string 7",
          "deliveryStatus": "sample string 8",
          "carrierReceiveDate": "2025-12-19T20:17:43.5928446+00:00",
          "transitDays": 10.0,
          "deliveryDate": "2025-12-19T20:17:43.5928446+00:00",
          "executionTime": 14,
          "txID": "sample string 15"
        }
      ],
      "executionTime": 18,
      "txID": "sample string 19"
    }
  ],
  "client": {
    "$id": "2",
    "executionTime": 19,
    "txID": "sample string 20"
  },
  "executionTime": 24,
  "txID": "sample string 25"
}

application/x-www-form-urlencoded

Sample:

Id=1&OrderNumber=b35c733e-eaae-49c6-963e-e230079b09e2&ShortOrderNumber=sample+string+1&ClientId=1&MemberId=1&OrderTypeId=Unknown&DisplayOrderType=sample+string+1&DisplayOrderStatus=sample+string+1&OrderSourceId=Unknown&OrderStatusId=Unknown&OrderDate=12%2f19%2f2025+3%3a18%3a26+PM&OrderTemplateId=1&ShipName=sample+string+1&ShipAddress1=sample+string+1&ShipAddress2=sample+string+1&ShipAddress3=sample+string+1&ShipCity=sample+string+1&ShipState=sample+string+1&ShipZip=sample+string+1&ShipPhone=sample+string+1&Email=sample+string+1&ShippingServiceLevel=sample+string+1&PreferredShipMethod=sample+string+1&PackslipMessage=sample+string+1&MustShipByDate=12%2f19%2f2025+3%3a18%3a26+PM&OrderItems=System.Collections.Generic.List%601%5bTulaERP.Contract.Models.OrderItem%5d&OrderShipments=System.Collections.Generic.List%601%5bTulaERP.Contract.Models.OrderShipment%5d&Client=TulaERP.Contract.Models.Client&ItemInventoryLedgers=System.Collections.Generic.List%601%5bTulaERP.Contract.Models.ItemInventoryLedgerEntry%5d&Member=TulaERP.Contract.Models.Member&OrderExtensions=System.Collections.Generic.List%601%5bTulaERP.Contract.Models.OrderExtension%5d&OrderStatu=TulaERP.Contract.Models.OrderStatus&OrderTemplate=TulaERP.Contract.Models.OrderTemplate&OrderType=TulaERP.Contract.Models.OrderType&DBStatus=Unknown&ClientName=sample+string+1&ModifiedDateTime=12%2f19%2f2025+3%3a18%3a26+PM&ExecutionTime=1&TxID=sample+string+1&ResultMessage=sample+string+1&ResultCode=1&ModifiedSessionId=1&RowVersion=System.Byte%5b%5d

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

Response Information

Resource Description

Order

Name	Description	Type
Id		integer
ShortOrderNumber	Short order number for the order. System generated	string
ClientId	Client ID for the order	integer
MemberId	Member ID for the order	integer
OrderTypeId	Order Type ID for the order	TOrderType
DisplayOrderType		string
DisplayOrderStatus		string
OrderSourceId	Order Type ID for the order	TOrderSource
OrderStatusId	Order Status ID for the order	TOrderStatus
OrderDate	Order Date for the order	date
OrderTemplateId	Not required for all orders. If you supply it, please make it accurate	integer
ShipName	Shipping name for the order	string
ShipAddress1	Shipping address line 1 for the order	string
ShipAddress2	Shipping address line 2 for the order	string
ShipAddress3	Shipping address line 3 for the order	string
ShipCity	Shipping city for the order	string
ShipState	Shipping state for the order	string
ShipZip	Shipping zip code for the order	string
ShipPhone	Shipping phone number for the order	string
Email	Email address for the order	string
ShippingServiceLevel	Shipping service level for the order	string
PreferredShipMethod	Preferred shipping method for the order	string
PackslipMessage	Packslip message for the order	string
MustShipByDate	Must ship by date for the order	date
OrderItems	Collection of order items	Collection of OrderItem
OrderShipments	Collection of order shipments	Collection of OrderShipment
Client	Client associated with the order	Client
ExecutionTime	How long the method took in milliseconds. System supplied value.	integer
TxID	Transaction ID of the call. Will be added for the response. Not needed in the request.	string

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "shortOrderNumber": "sample string 3",
  "clientId": 4,
  "memberId": 5,
  "orderTypeId": "Unknown",
  "displayOrderType": "sample string 6",
  "displayOrderStatus": "sample string 7",
  "orderSourceId": "Unknown",
  "orderStatusId": "Unknown",
  "orderDate": "2025-12-19T20:17:43.6397208+00:00",
  "orderTemplateId": 1,
  "shipName": "sample string 9",
  "shipAddress1": "sample string 10",
  "shipAddress2": "sample string 11",
  "shipAddress3": "sample string 12",
  "shipCity": "sample string 13",
  "shipState": "sample string 14",
  "shipZip": "sample string 15",
  "shipPhone": "sample string 16",
  "email": "sample string 17",
  "shippingServiceLevel": "sample string 18",
  "preferredShipMethod": "sample string 19",
  "packslipMessage": "sample string 20",
  "mustShipByDate": "2025-12-19T20:17:43.6397208+00:00",
  "orderItems": [
    {
      "itemCode": "sample string 4",
      "quantity": 5,
      "item": {
        "$id": "1",
        "executionTime": 28,
        "txID": "sample string 29"
      },
      "executionTime": 8,
      "txID": "sample string 9"
    },
    {
      "itemCode": "sample string 4",
      "quantity": 5,
      "item": {
        "$ref": "1"
      },
      "executionTime": 8,
      "txID": "sample string 9"
    }
  ],
  "orderShipments": [
    {
      "id": 1,
      "orderId": 2,
      "shortOrderNumber": "sample string 3",
      "orderShipmentDate": "2025-12-19T20:17:43.6397208+00:00",
      "orderShipmentPackageNumber": 5,
      "orderShipmentStatusId": "Unknown",
      "warehouseId": 6,
      "shipName": "sample string 7",
      "shipAddress1": "sample string 8",
      "shipAddress2": "sample string 9",
      "shipAddress3": "sample string 10",
      "shipCity": "sample string 11",
      "shipState": "sample string 12",
      "shipZip": "sample string 13",
      "shipPhone": "sample string 14",
      "weight": 15.0,
      "orderShipmentItems": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-12-19T20:17:43.6397208+00:00",
          "kitBuildBarcode": "sample string 7",
          "executionTime": 10,
          "txID": "sample string 11"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-12-19T20:17:43.6397208+00:00",
          "kitBuildBarcode": "sample string 7",
          "executionTime": 10,
          "txID": "sample string 11"
        }
      ],
      "orderShipmentPackages": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "trackingLink": "sample string 7",
          "deliveryStatus": "sample string 8",
          "carrierReceiveDate": "2025-12-19T20:17:43.6397208+00:00",
          "transitDays": 10.0,
          "deliveryDate": "2025-12-19T20:17:43.6397208+00:00",
          "executionTime": 14,
          "txID": "sample string 15"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "trackingLink": "sample string 7",
          "deliveryStatus": "sample string 8",
          "carrierReceiveDate": "2025-12-19T20:17:43.6397208+00:00",
          "transitDays": 10.0,
          "deliveryDate": "2025-12-19T20:17:43.6397208+00:00",
          "executionTime": 14,
          "txID": "sample string 15"
        }
      ],
      "executionTime": 18,
      "txID": "sample string 19"
    },
    {
      "id": 1,
      "orderId": 2,
      "shortOrderNumber": "sample string 3",
      "orderShipmentDate": "2025-12-19T20:17:43.6397208+00:00",
      "orderShipmentPackageNumber": 5,
      "orderShipmentStatusId": "Unknown",
      "warehouseId": 6,
      "shipName": "sample string 7",
      "shipAddress1": "sample string 8",
      "shipAddress2": "sample string 9",
      "shipAddress3": "sample string 10",
      "shipCity": "sample string 11",
      "shipState": "sample string 12",
      "shipZip": "sample string 13",
      "shipPhone": "sample string 14",
      "weight": 15.0,
      "orderShipmentItems": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-12-19T20:17:43.6397208+00:00",
          "kitBuildBarcode": "sample string 7",
          "executionTime": 10,
          "txID": "sample string 11"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "itemId": 3,
          "itemCode": "sample string 4",
          "quantity": 5,
          "locationName": "sample string 6",
          "pickedQuantity": 1,
          "pickedDateTime": "2025-12-19T20:17:43.6397208+00:00",
          "kitBuildBarcode": "sample string 7",
          "executionTime": 10,
          "txID": "sample string 11"
        }
      ],
      "orderShipmentPackages": [
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "trackingLink": "sample string 7",
          "deliveryStatus": "sample string 8",
          "carrierReceiveDate": "2025-12-19T20:17:43.6397208+00:00",
          "transitDays": 10.0,
          "deliveryDate": "2025-12-19T20:17:43.6397208+00:00",
          "executionTime": 14,
          "txID": "sample string 15"
        },
        {
          "id": 1,
          "orderShipmentId": 2,
          "packageNumber": 3,
          "actualShipWeight": 1.0,
          "shipCarrier": "sample string 4",
          "trackingNumber1": "sample string 5",
          "trackingNumber2": "sample string 6",
          "trackingLink": "sample string 7",
          "deliveryStatus": "sample string 8",
          "carrierReceiveDate": "2025-12-19T20:17:43.6397208+00:00",
          "transitDays": 10.0,
          "deliveryDate": "2025-12-19T20:17:43.6397208+00:00",
          "executionTime": 14,
          "txID": "sample string 15"
        }
      ],
      "executionTime": 18,
      "txID": "sample string 19"
    }
  ],
  "client": {
    "$id": "2",
    "executionTime": 19,
    "txID": "sample string 20"
  },
  "executionTime": 24,
  "txID": "sample string 25"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.