POST api/SalesOrderHeaders
Request Information
URI Parameters
None.
Body Parameters
SalesOrderHeader| Name | Description | Type | Additional information |
|---|---|---|---|
| SalesOrderHeaderId | integer |
None. |
|
| DealerId | integer |
None. |
|
| CreateDate | date |
None. |
|
| CreatedByUserId | integer |
None. |
|
| OrderTypeId | integer |
None. |
|
| CustomerRef | string |
String length: inclusive between 0 and 50 |
|
| OrderNumber | string |
String length: inclusive between 0 and 20 |
|
| OrderAddressId | integer |
None. |
|
| RmaNumber | string |
String length: inclusive between 0 and 10 |
|
| StatusId | integer |
None. |
|
| OldOrderNumber | string |
None. |
|
| Notes | string |
None. |
|
| AlternativeAddressId | integer |
None. |
|
| OrderType | OrderType |
None. |
|
| User | User |
None. |
|
| SalesOrderLines | Collection of SalesOrderLine |
None. |
Request Formats
application/json, text/json
Sample:
{
"salesOrderHeaderId": 1,
"dealerId": 2,
"createDate": "2025-09-01T00:37:52.2876233+00:00",
"createdByUserId": 4,
"orderTypeId": 5,
"customerRef": "sample string 6",
"orderNumber": "sample string 7",
"orderAddressId": 1,
"rmaNumber": "sample string 8",
"statusId": 1,
"oldOrderNumber": "sample string 9",
"notes": "sample string 10",
"alternativeAddressId": 1,
"orderType": {
"$id": "2",
"id": 1,
"code": "sample string 2",
"description": "sample string 3",
"dropdowngroup": true,
"basketHeaders": {
"$id": "3",
"$values": [
{
"$id": "4",
"basketHeaderId": 1,
"dealerId": 2,
"createDate": "2025-09-01T00:37:52.2876233+00:00",
"createdByUserId": 3,
"addressId": 1,
"orderTypeId": 4,
"customerReference": "sample string 5",
"alternativeAddressId": 1,
"orderType": {
"$ref": "2"
},
"basketLines": {
"$id": "5",
"$values": [
{
"$id": "6",
"basketLineId": 1,
"basketHeaderId": 2,
"partId": 3,
"quantity": 4,
"statusId": 1,
"createdDate": "2025-09-01T00:37:52.2876233+00:00",
"lineCost": 1.0,
"exceptionId": 1,
"dropShip": "sample string 6",
"discount": 1.0,
"surcharge": 1.0,
"basketHeader": {
"$ref": "4"
},
"part": {
"$id": "7",
"partId": 1,
"partNumber": "sample string 2",
"partDescription": "sample string 3",
"series": "sample string 4",
"element": 1,
"unit": "sample string 5",
"unitQty": 1.1,
"special": true,
"vor": true,
"superceeded": true,
"restricted": true,
"vatCode": 1,
"coOrigin": "sample string 6",
"partOrderTypeId": 1,
"emissionsCritical": true,
"exchangePart": true,
"surchargeValue": 1.1,
"requiredFieldsCode": 1,
"uoi": 1,
"stock_Discount": 1.1,
"voR_Discount": 1.1,
"unitOfSale": 1,
"maxQty": 1,
"template": "sample string 7"
}
},
{
"$ref": "6"
}
]
}
},
{
"$ref": "4"
}
]
}
},
"user": {
"$id": "8",
"userId": 1,
"salesDealerId": 1,
"partsDealerId": 1,
"userName": "sample string 2",
"email": "sample string 3",
"dealer": {
"$id": "9",
"dealerId": 1,
"dealerName": "sample string 2",
"dealerAKA": "sample string 3",
"accountNumber": "sample string 4",
"users": {
"$id": "10",
"$values": [
{
"$ref": "8"
},
{
"$ref": "8"
}
]
},
"users1": {
"$id": "11",
"$values": [
{
"$ref": "8"
},
{
"$ref": "8"
}
]
}
},
"dealer1": {
"$ref": "9"
},
"salesOrderHeaders": {
"$id": "12",
"$values": [
{
"$ref": "1"
},
{
"$ref": "1"
}
]
}
},
"salesOrderLines": {
"$id": "13",
"$values": [
{
"$id": "14",
"salesOrderLineId": 1,
"salesOrderHeaderId": 2,
"partId": 3,
"quantity": 4,
"statusId": 1,
"createdDate": "2025-09-01T00:37:52.2876233+00:00",
"lineCost": 1.0,
"exceptionId": 1,
"part": {
"$ref": "7"
},
"amlbackorder": true,
"asnDate": "2025-09-01T00:37:52.2876233+00:00",
"shippedQuantity": 1,
"oldOrderItemNumber": "sample string 7",
"itemNo": 8,
"discount": 1.0,
"surcharge": 1.0,
"salesOrderHeader": {
"$ref": "1"
}
},
{
"$ref": "14"
}
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SalesOrderHeader| Name | Description | Type | Additional information |
|---|---|---|---|
| SalesOrderHeaderId | integer |
None. |
|
| DealerId | integer |
None. |
|
| CreateDate | date |
None. |
|
| CreatedByUserId | integer |
None. |
|
| OrderTypeId | integer |
None. |
|
| CustomerRef | string |
String length: inclusive between 0 and 50 |
|
| OrderNumber | string |
String length: inclusive between 0 and 20 |
|
| OrderAddressId | integer |
None. |
|
| RmaNumber | string |
String length: inclusive between 0 and 10 |
|
| StatusId | integer |
None. |
|
| OldOrderNumber | string |
None. |
|
| Notes | string |
None. |
|
| AlternativeAddressId | integer |
None. |
|
| OrderType | OrderType |
None. |
|
| User | User |
None. |
|
| SalesOrderLines | Collection of SalesOrderLine |
None. |
Response Formats
application/json, text/json
Sample:
{
"salesOrderHeaderId": 1,
"dealerId": 2,
"createDate": "2025-09-01T00:37:52.2876233+00:00",
"createdByUserId": 4,
"orderTypeId": 5,
"customerRef": "sample string 6",
"orderNumber": "sample string 7",
"orderAddressId": 1,
"rmaNumber": "sample string 8",
"statusId": 1,
"oldOrderNumber": "sample string 9",
"notes": "sample string 10",
"alternativeAddressId": 1,
"orderType": {
"$id": "2",
"id": 1,
"code": "sample string 2",
"description": "sample string 3",
"dropdowngroup": true,
"basketHeaders": {
"$id": "3",
"$values": [
{
"$id": "4",
"basketHeaderId": 1,
"dealerId": 2,
"createDate": "2025-09-01T00:37:52.2876233+00:00",
"createdByUserId": 3,
"addressId": 1,
"orderTypeId": 4,
"customerReference": "sample string 5",
"alternativeAddressId": 1,
"orderType": {
"$ref": "2"
},
"basketLines": {
"$id": "5",
"$values": [
{
"$id": "6",
"basketLineId": 1,
"basketHeaderId": 2,
"partId": 3,
"quantity": 4,
"statusId": 1,
"createdDate": "2025-09-01T00:37:52.2876233+00:00",
"lineCost": 1.0,
"exceptionId": 1,
"dropShip": "sample string 6",
"discount": 1.0,
"surcharge": 1.0,
"basketHeader": {
"$ref": "4"
},
"part": {
"$id": "7",
"partId": 1,
"partNumber": "sample string 2",
"partDescription": "sample string 3",
"series": "sample string 4",
"element": 1,
"unit": "sample string 5",
"unitQty": 1.1,
"special": true,
"vor": true,
"superceeded": true,
"restricted": true,
"vatCode": 1,
"coOrigin": "sample string 6",
"partOrderTypeId": 1,
"emissionsCritical": true,
"exchangePart": true,
"surchargeValue": 1.1,
"requiredFieldsCode": 1,
"uoi": 1,
"stock_Discount": 1.1,
"voR_Discount": 1.1,
"unitOfSale": 1,
"maxQty": 1,
"template": "sample string 7"
}
},
{
"$ref": "6"
}
]
}
},
{
"$ref": "4"
}
]
}
},
"user": {
"$id": "8",
"userId": 1,
"salesDealerId": 1,
"partsDealerId": 1,
"userName": "sample string 2",
"email": "sample string 3",
"dealer": {
"$id": "9",
"dealerId": 1,
"dealerName": "sample string 2",
"dealerAKA": "sample string 3",
"accountNumber": "sample string 4",
"users": {
"$id": "10",
"$values": [
{
"$ref": "8"
},
{
"$ref": "8"
}
]
},
"users1": {
"$id": "11",
"$values": [
{
"$ref": "8"
},
{
"$ref": "8"
}
]
}
},
"dealer1": {
"$ref": "9"
},
"salesOrderHeaders": {
"$id": "12",
"$values": [
{
"$ref": "1"
},
{
"$ref": "1"
}
]
}
},
"salesOrderLines": {
"$id": "13",
"$values": [
{
"$id": "14",
"salesOrderLineId": 1,
"salesOrderHeaderId": 2,
"partId": 3,
"quantity": 4,
"statusId": 1,
"createdDate": "2025-09-01T00:37:52.2876233+00:00",
"lineCost": 1.0,
"exceptionId": 1,
"part": {
"$ref": "7"
},
"amlbackorder": true,
"asnDate": "2025-09-01T00:37:52.2876233+00:00",
"shippedQuantity": 1,
"oldOrderItemNumber": "sample string 7",
"itemNo": 8,
"discount": 1.0,
"surcharge": 1.0,
"salesOrderHeader": {
"$ref": "1"
}
},
{
"$ref": "14"
}
]
}
}