POST salesorder

By Customer Code, POST New Sales Order (Customer, Shipto, SO Item Lines, New Receipt)

Request Information

URI Parameters

None.

Body Parameters

Interprise.Web.Services.Models.SalesOrderInput
NameDescriptionTypeAdditional information
CustomerCode

string

None.

Email

Optional, use by POST SalesOrder/Advance. Specify when creating new customer or when trying to create an order for a customer linked to the email address.

string

None.

POCode

string

None.

SalesRepOrderCode

string

None.

PaymentTerm

string

None.

Notes

string

None.

SourceCode

string

None.

IsQuote

Indicates if a sales order or a quote will be created. Default is sales order

boolean

None.

FreightTaxCode

Specify if you want to override default Freight Tax

string

None.

FreightAmount

decimal number

None.

OtherAmount

decimal number

None.

SalesOrderDate

date

None.

ShippingDate

date

None.

ContactCode

string

None.

WebsiteCode

string

None.

OpportunityCode

string

None.

OverallDueDate

Sales order cancel date

date

None.

IsApprovedCreditHold

Indicates if a sales order will be created when a customer credit status is on hold.

boolean

None.

WarehouseCode

string

None.

ShipAddress

Interprise.Web.Services.Models.Address

None.

BillToAddress

Interprise.Web.Services.Models.BillAddress

None.

PaymentDetails

Applies to sales order transaction, leave it empty when creating a quote

Interprise.Web.Services.Models.PaymentInfo

None.

AuthResponse

Applies to sales order transaction, leave it empty when creating a quote

Interprise.Web.Services.Models.CCAuthResponse

None.

Items

Collection of Interprise.Web.Services.Models.SalesOrderItem

None.

CustomFields

Collection of all the custom fields within a model

Collection of Interprise.Web.Services.Models.CustomField

None.

Request Formats

{
  "customerCode": "sample string 1",
  "email": "sample string 2",
  "poCode": "sample string 3",
  "salesRepOrderCode": "sample string 4",
  "paymentTerm": "sample string 5",
  "notes": "sample string 6",
  "sourceCode": "sample string 7",
  "isQuote": true,
  "freightTaxCode": "sample string 8",
  "freightAmount": 1.0,
  "otherAmount": 1.0,
  "salesOrderDate": "2024-04-24T16:16:59.2175324+01:00",
  "shippingDate": "2024-04-24T16:16:59.2175324+01:00",
  "contactCode": "sample string 9",
  "websiteCode": "sample string 10",
  "opportunityCode": "sample string 11",
  "overallDueDate": "2024-04-24T16:16:59.2175324+01:00",
  "isApprovedCreditHold": true,
  "warehouseCode": "sample string 12",
  "shipAddress": {
    "shipToName": "sample string 1",
    "shipToCode": "sample string 2",
    "shippingMethodCode": "sample string 3",
    "shipToAddress": "sample string 4",
    "shipToCity": "sample string 5",
    "shipToState": "sample string 6",
    "shipToPostalCode": "sample string 7",
    "shipToCountry": "sample string 8",
    "shipToCounty": "sample string 9",
    "shipToPhone": "sample string 10",
    "shipToPhoneExt": "sample string 11"
  },
  "billToAddress": {
    "billToName": "sample string 1",
    "billToAddress": "sample string 2",
    "billToCity": "sample string 3",
    "billToState": "sample string 4",
    "billToPostalCode": "sample string 5",
    "billToCounty": "sample string 6",
    "billToCountry": "sample string 7",
    "billToPhone": "sample string 8",
    "billToPhoneExt": "sample string 9"
  },
  "paymentDetails": {
    "paymentMethod": "sample string 1",
    "paymentType": "sample string 2",
    "authorize": "sample string 6",
    "cardNumber": "sample string 7",
    "checkNumber": "sample string 8",
    "nameOnCard": "sample string 9",
    "cardType": "sample string 10",
    "cardExpMonth": "sample string 11",
    "cardExpYear": "sample string 12",
    "cardSecurityNumber": "sample string 13",
    "cardAddress": "sample string 14",
    "cardCity": "sample string 15",
    "cardCountry": "sample string 16",
    "cardPostalCode": "sample string 17",
    "cardEmail": "sample string 18",
    "receiptAmount": 1.0
  },
  "authResponse": {
    "documentCode": "sample string 1",
    "reference": "sample string 2",
    "responseMsg": "sample string 3",
    "authCode": "sample string 4",
    "avsResult": "sample string 5",
    "cvResult": "sample string 6",
    "message": "sample string 7",
    "authorizationResult": "sample string 8",
    "gatewayResponseCode": "sample string 9",
    "creditCardIsAuthorized": "sample string 10"
  },
  "items": [
    {
      "itemName": "sample string 1",
      "itemDescription": "sample string 2",
      "customerItemName": "sample string 3",
      "unitMeasureCode": "sample string 4",
      "warehouseCode": "sample string 5",
      "itemQuantity": 1.0,
      "itemUnitPrice": 1.0,
      "netItemPrice": 1.0,
      "taxCode": "sample string 6",
      "dueDate": "2024-04-24T16:16:59.2185636+01:00",
      "isKitItemPrice": true,
      "isUseCustomerPricing": true,
      "isExcludeOptionalItem": true,
      "customFields": [
        {
          "field": "sample string 1",
          "value": {}
        },
        {
          "field": "sample string 1",
          "value": {}
        }
      ],
      "kitGroupItems": [
        {
          "groupCode": "sample string 1",
          "itemName": "sample string 2",
          "itemUnitPrice": 1.0,
          "itemCode": "sample string 3"
        },
        {
          "groupCode": "sample string 1",
          "itemName": "sample string 2",
          "itemUnitPrice": 1.0,
          "itemCode": "sample string 3"
        }
      ]
    },
    {
      "itemName": "sample string 1",
      "itemDescription": "sample string 2",
      "customerItemName": "sample string 3",
      "unitMeasureCode": "sample string 4",
      "warehouseCode": "sample string 5",
      "itemQuantity": 1.0,
      "itemUnitPrice": 1.0,
      "netItemPrice": 1.0,
      "taxCode": "sample string 6",
      "dueDate": "2024-04-24T16:16:59.2185636+01:00",
      "isKitItemPrice": true,
      "isUseCustomerPricing": true,
      "isExcludeOptionalItem": true,
      "customFields": [
        {
          "field": "sample string 1",
          "value": {}
        },
        {
          "field": "sample string 1",
          "value": {}
        }
      ],
      "kitGroupItems": [
        {
          "groupCode": "sample string 1",
          "itemName": "sample string 2",
          "itemUnitPrice": 1.0,
          "itemCode": "sample string 3"
        },
        {
          "groupCode": "sample string 1",
          "itemName": "sample string 2",
          "itemUnitPrice": 1.0,
          "itemCode": "sample string 3"
        }
      ]
    }
  ],
  "customFields": [
    {
      "field": "sample string 1",
      "value": {}
    },
    {
      "field": "sample string 1",
      "value": {}
    }
  ]
}

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'SalesOrderInput'.

Response Information

Resource Description

Sales order

Interprise.Web.Services.Http.MetadataOfInterprise.Web.Services.Models.SalesOrderInput
NameDescriptionTypeAdditional information
data

Interprise.Web.Services.Http.DataNodeOfInterprise.Web.Services.Models.SalesOrderInput

None.

links

Interprise.Web.Services.Http.LinksNode

None.

Response Formats

Sample not available.