POST api/Order/SubmitOrder
Request Information
URI Parameters
None.
Body Parameters
OrderName | Description | Type | Additional information |
---|---|---|---|
Discount | decimal number |
None. |
|
Charges | decimal number |
None. |
|
OrderStatus | integer |
None. |
|
PONumber | string |
Max length: 22 |
|
OrderNumber | string |
None. |
|
InvoiceNumber | string |
Max length: 20 |
|
SAPOrderNumber | string |
None. |
|
DateStamp | date |
None. |
|
ShipDate | date |
None. |
|
DeliveryDate | date |
None. |
|
EstimatedArrivalTime | date |
None. |
|
ShipmentNumber | string |
None. |
|
CarrierID | string |
None. |
|
Carrier | string |
None. |
|
Status | string |
None. |
|
TotalOrderedWeight | decimal number |
None. |
|
TotalWeight | decimal number |
None. |
|
TotalInvoiceWeight | decimal number |
None. |
|
DateSubmitted | date |
None. |
|
OrderDetails | Collection of OrderDetail |
None. |
|
CustomerShipToID | string |
None. |
|
CustomerBillToID | string |
None. |
|
EDIStatus | string |
None. |
|
Incoterms | string |
None. |
|
InvoiceDate | date |
None. |
|
PaymentDueDate | date |
None. |
|
DeliveryNumber | string |
None. |
|
PaymentTerms | string |
None. |
|
InvoicedTotalDiscount | decimal number |
None. |
|
InvoicedTotalCharges | decimal number |
None. |
|
OrderStatusDescription | string |
None. |
|
isLocked | boolean |
None. |
|
BillToAddress | string |
None. |
|
ShipToAddress | string |
None. |
|
TotalPrice | decimal number |
None. |
|
isMarketPrice | boolean |
None. |
|
Id | globally unique identifier |
None. |
|
Comments | string |
None. |
|
DateCreated | date |
None. |
|
DateModified | date |
None. |
Request Formats
application/json, text/json
Sample:
{ "Discount": 1.0, "Charges": 2.0, "OrderStatus": 3, "PONumber": "sample string 4", "OrderNumber": "sample string 5", "InvoiceNumber": "sample string 6", "SAPOrderNumber": "sample string 7", "DateStamp": "2024-12-03T16:46:01.0764712+00:00", "ShipDate": "2024-12-03T16:46:01.0764712+00:00", "DeliveryDate": "2024-12-03T16:46:01.0764712+00:00", "EstimatedArrivalTime": "2024-12-03T16:46:01.0764712+00:00", "ShipmentNumber": "sample string 9", "CarrierID": "sample string 10", "Carrier": "sample string 11", "Status": "sample string 12", "TotalOrderedWeight": 1.0, "TotalWeight": 1.0, "TotalInvoiceWeight": 1.0, "DateSubmitted": "2024-12-03T16:46:01.0764712+00:00", "OrderDetails": [ { "Discount": 1.0, "OrderId": "96f03beb-0046-45b8-9404-cd8dc9c42e1c", "ConfirmedQuantity": 3, "InvoicedQuantity": 4, "ConfirmedNetWeight": 5.0, "ConfirmedNetWeightUnit": "sample string 6", "InvoicedNetWeight": 7.0, "InvoicedNetWeightUnit": "sample string 8", "TotalConfirmedNetWeight": 9.0, "TotalConfirmedNetWeightUnit": "sample string 10", "TotalInvoicedNetWeight": 11.0, "TotalInvoicedNetWeightUnit": "sample string 12", "Price": 13.0, "Per": "sample string 14", "Charges": [ { "Type": "sample string 2", "Amount": 3.0, "InvoiceAmount": 4.0, "Description": "sample string 5" }, { "Type": "sample string 2", "Amount": 3.0, "InvoiceAmount": 4.0, "Description": "sample string 5" } ], "Discounts": [ { "Type": "sample string 2", "Amount": 3.0, "InvoiceAmount": 4.0, "Description": "sample string 5" }, { "Type": "sample string 2", "Amount": 3.0, "InvoiceAmount": 4.0, "Description": "sample string 5" } ], "TotalPrice": 15.0, "Id": "727a4c3f-4f44-40b7-a20c-ef67e9501199", "UnitPrice": "sample string 17", "Quantity": 18, "MaterialID": "sample string 19", "Material": { "MaterialID": "sample string 1", "Description": "sample string 2", "Family": "sample string 3", "SubFamily": "sample string 4", "Brand": "sample string 5", "DisplayUPC": "sample string 6", "GTIN": "sample string 7", "ShelfLife": "sample string 8", "CodeDating": "sample string 9", "RefrigerationText": "sample string 10", "Establishment": "sample string 11", "Characteristics": "sample string 12", "Allergens": "sample string 13", "UMConversions": "sample string 14", "Package": "sample string 15", "Case": "sample string 16", "CaseWeightType": "sample string 17", "CaseWt": "sample string 18", "ShippingWt": "sample string 19", "Pallet": "sample string 20", "SellingRestriction": "sample string 21", "CaseUPC": "sample string 22", "ImageUrl": "sample string 23", "NutritionFactsUrl": "sample string 24", "SellingUnit": "sample string 25", "ConversionFactor": "sample string 26" }, "DateAdded": "2024-12-03T16:46:01.0764712+00:00" }, { "Discount": 1.0, "OrderId": "96f03beb-0046-45b8-9404-cd8dc9c42e1c", "ConfirmedQuantity": 3, "InvoicedQuantity": 4, "ConfirmedNetWeight": 5.0, "ConfirmedNetWeightUnit": "sample string 6", "InvoicedNetWeight": 7.0, "InvoicedNetWeightUnit": "sample string 8", "TotalConfirmedNetWeight": 9.0, "TotalConfirmedNetWeightUnit": "sample string 10", "TotalInvoicedNetWeight": 11.0, "TotalInvoicedNetWeightUnit": "sample string 12", "Price": 13.0, "Per": "sample string 14", "Charges": [ { "Type": "sample string 2", "Amount": 3.0, "InvoiceAmount": 4.0, "Description": "sample string 5" }, { "Type": "sample string 2", "Amount": 3.0, "InvoiceAmount": 4.0, "Description": "sample string 5" } ], "Discounts": [ { "Type": "sample string 2", "Amount": 3.0, "InvoiceAmount": 4.0, "Description": "sample string 5" }, { "Type": "sample string 2", "Amount": 3.0, "InvoiceAmount": 4.0, "Description": "sample string 5" } ], "TotalPrice": 15.0, "Id": "727a4c3f-4f44-40b7-a20c-ef67e9501199", "UnitPrice": "sample string 17", "Quantity": 18, "MaterialID": "sample string 19", "Material": { "MaterialID": "sample string 1", "Description": "sample string 2", "Family": "sample string 3", "SubFamily": "sample string 4", "Brand": "sample string 5", "DisplayUPC": "sample string 6", "GTIN": "sample string 7", "ShelfLife": "sample string 8", "CodeDating": "sample string 9", "RefrigerationText": "sample string 10", "Establishment": "sample string 11", "Characteristics": "sample string 12", "Allergens": "sample string 13", "UMConversions": "sample string 14", "Package": "sample string 15", "Case": "sample string 16", "CaseWeightType": "sample string 17", "CaseWt": "sample string 18", "ShippingWt": "sample string 19", "Pallet": "sample string 20", "SellingRestriction": "sample string 21", "CaseUPC": "sample string 22", "ImageUrl": "sample string 23", "NutritionFactsUrl": "sample string 24", "SellingUnit": "sample string 25", "ConversionFactor": "sample string 26" }, "DateAdded": "2024-12-03T16:46:01.0764712+00:00" } ], "CustomerShipToID": "sample string 13", "CustomerBillToID": "sample string 14", "EDIStatus": "sample string 15", "Incoterms": "sample string 16", "InvoiceDate": "2024-12-03T16:46:01.0764712+00:00", "PaymentDueDate": "2024-12-03T16:46:01.0764712+00:00", "DeliveryNumber": "sample string 17", "PaymentTerms": "sample string 18", "InvoicedTotalDiscount": 19.0, "InvoicedTotalCharges": 20.0, "OrderStatusDescription": "sample string 21", "isLocked": true, "BillToAddress": "sample string 23", "ShipToAddress": "sample string 24", "TotalPrice": 25.0, "isMarketPrice": true, "Id": "d89f3fe6-9af1-4f64-b00b-10e59280a5b0", "Comments": "sample string 28", "DateCreated": "2024-12-03T16:46:01.0764712+00:00", "DateModified": "2024-12-03T16:46:01.0764712+00:00" }
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
DataResultOfBooleanName | Description | Type | Additional information |
---|---|---|---|
Value | RetVal |
None. |
|
Message | string |
None. |
|
Data | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Value": 0, "Message": "sample string 1", "Data": true }