api/SalesOrder/Create (POST)
Creates a new Sales Order using the supplied creation data.
HTTP Method: POST
Required Fields:
- SalesOrder: SO_ID*, CUSTOMER_ID
- SalesOrderLine: SO_LINE_NO, PART_ID or SO_DESC
- SalesOrderComment: SO_LINE_NO, PRINT_INVOICE, COMMENT_TEXT
- SalesOrderExtendedUser: SO_LINE_NO
* If Auto SO ID is enabled then SO_ID is not required in SalesOrder.
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Sales Order.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing Sales Order creation data.
Create Sales Order Example:
{
"SalesOrder": {
"SO_ID": "123456",
"CUSTOMER_ID": "ABCCORP",
"NOTES": "Notes can be up to 32,765 characters long.",
"ATTACHMENTS": "http://www.expandable.com/|C:\\Expandable.docx"
},
"SalesOrderLine": [
{
"SO_LINE_NO": "1",
"PART_ID": "MOTOR003",
"ORDER_QTY": "2",
"SO_UNIT_PRICE": "3500.00"
},
{
"SO_LINE_NO": "2",
"PART_ID": "MOUNT007",
"ORDER_QTY": "4",
"SO_UNIT_PRICE": "60.00"
}
],
"SalesOrderComment": [
{
"SO_LINE_NO": "0",
"PRINT_INVOICE": "O",
"COMMENT_TEXT": "Order comment."
},
{
"SO_LINE_NO": "1",
"PRINT_INVOICE": "O",
"COMMENT_TEXT": "Line 1 comment."
},
{
"SO_LINE_NO": "2",
"PRINT_INVOICE": "O",
"COMMENT_TEXT": "Line 2 comment."
}
],
"SalesOrderExtendedUser": [
{
"SO_LINE_NO": "1",
"SOFDXU_USER_1": "ZSVB",
"SOFDXU_USER_25": "7/20/2012",
"SOFDXU_USER_34": "13.55"
}
]
}
Returns 1 Sales Order if successful.
This is like 'Insert' in Expandable.
Accepted Sales Order Fields:
ATTACHMENTS, ATTENTION, BILL_TO_CUST, COMPLETE_ONLY,
CONFIRMED_TO, CUST_PO_ID, CUSTOMER_ID, DELAY_DAYS,
DELAY_INVOICE, E_MAIL, E_MAIL_DATE, FOB,
FREIGHT_CODE, GL_MONTH, GL_YEAR, NOTES,
ORDER_CLASS, ORDER_DATE, ORDER_DISC_PCT, ORDER_TAKER,
REFERENCE, SALES_REGION, SALESMAN_ID, SHIP_METHOD,
SHIP_NOTE_1, SHIP_NOTE_2, SHIP_TO_CUST, SO_HOLD,
SO_ID, SO_STATUS, SO_TYPE, SOFOM_USER_1,
SOFOM_USER_2, SOFOM_USER_3, SOFOM_USER_4, SOFOM_USER_5,
SOFOM_USER_6, SOFOM_USER_7, SOFOM_USER_8, SOFOM_USER_9,
SOFOM_USER_10, SOFOM_USER_11, SOFOM_USER_12, SOFOM_USER_13,
SOFOM_USER_14, SOFOM_USER_15, SOFOM_USER_16, SOFOM_USER_17,
SOFOM_USER_18, SOFOM_USER_19, SOFOM_USER_20, SOFOM_USER_21,
SOFOM_USER_22, SOFOM_USER_23, SOFOM_USER_24, SOFOM_USER_25,
SOFOM_USER_26, SOFOM_USER_27, SOFOM_USER_28, SOFOM_USER_29,
SOFOM_USER_30, SOFOM_USER_31, SOFOM_USER_32, SOFOM_USER_33,
SOFOM_USER_34, SOFOM_USER_35, SOFOM_USER_36, SOFOM_USER_37,
SOFOM_USER_38, SOFOM_USER_39, SOFOM_USER_40, SOFOM_USER_41,
SOFOM_USER_42, SOFOM_USER_43, SOFOM_USER_44, SOFOM_USER_45,
SOFOM_USER_46, SOFOM_USER_47, SOFOM_USER_48, SOFOM_USER_49,
SOFOM_USER_50, SOFOM_USER_51, SOFOM_USER_52, SOFOM_USER_53,
SOFOM_USER_54, SOFOM_USER_55, SOFOM_USER_56, SOFOM_USER_57,
SOFOM_USER_58, SOFOM_USER_59, SOFOM_USER_60, SOFOM_USER_61,
SOFOM_USER_62, SOFOM_USER_63, SOFOM_USER_64, SOFOM_USER_65,
SOFOM_USER_66, SOFOM_USER_67, SOFOM_USER_68, SOFOM_USER_69,
SOFOM_USER_70, SOFOM_USER_71, SOFOM_USER_72, SOFOM_USER_73,
SOFOM_USER_74, SOFOM_USER_75, SOFOM_USER_76, SOFOM_USER_77,
SOFOM_USER_78, SOFOM_USER_79, SOFOM_USER_80, SOFOM_USER_81,
SOFOM_USER_82, SOFOM_USER_83, SOFOM_USER_84, SOFOM_USER_85,
SOFOM_USER_86, SOFOM_USER_87, SOFOM_USER_88, TAX_CODE,
TERMS_CODE
Accepted Sales Order Line Fields:
COMPANY_ID, CREATE_PO, CUST_PART_ID, CUST_PO_LINE,
DWG_REV, EARLY_SHIP, ECN, EXPECTED_SN,
FOB, FREIGHT_CODE, ITEM_DISC_PCT, JOB_ID,
OPTION_TYPE, ORDER_QTY, PART_ID, PARTIAL_SHIP,
PICK_DATE, PRICE_CODE, PRIORITY_CODE, PROD_DISC_CODE1,
PROD_DISC_CODE2, PROD_DISC_CODE3, PRODUCT_LINE, RA_REASON,
REQ_SHIP_DATE, SALES_ACCT, SALES_DEPT, SCH_SHIP_DATE,
SHIP_METHOD, SHIP_TYPE, SN_REQD, SO_DESC,
SO_ID, SO_LINE_CAT, SO_LINE_HOLD, SO_LINE_NO,
SO_LINE_STATUS, SO_UM, SO_UNIT_COST, SO_UNIT_PRICE,
SOFOD_USER_1, SOFOD_USER_2, SOFOD_USER_3, SOFOD_USER_4,
SOFOD_USER_5, SOFOD_USER_6, SOFOD_USER_7, SOFOD_USER_8,
SOFOD_USER_9, SOFOD_USER_10, SOFOD_USER_11, SOFOD_USER_12,
SOFOD_USER_13, SOFOD_USER_14, SOFOD_USER_15, SOFOD_USER_16,
STORES_CODE, TAX_CODE, TO_STORES, VAT_CODE,
XREF_SO_ID, XREF_SO_LINE, XREF_TYPE
Accepted Sales Order Comment Fields:
COMMENT_ID, COMMENT_TEXT, PRINT_INVOICE, SO_ID,
SO_LINE_NO
Accepted Sales Order Extended User Fields:
SO_ID, SO_LINE_NO, SOFDXU_USER_1, SOFDXU_USER_2,
SOFDXU_USER_3, SOFDXU_USER_4, SOFDXU_USER_5, SOFDXU_USER_6,
SOFDXU_USER_7, SOFDXU_USER_8, SOFDXU_USER_9, SOFDXU_USER_10,
SOFDXU_USER_11, SOFDXU_USER_12, SOFDXU_USER_13, SOFDXU_USER_14,
SOFDXU_USER_15, SOFDXU_USER_16, SOFDXU_USER_17, SOFDXU_USER_18,
SOFDXU_USER_19, SOFDXU_USER_20, SOFDXU_USER_21, SOFDXU_USER_22,
SOFDXU_USER_23, SOFDXU_USER_24, SOFDXU_USER_25, SOFDXU_USER_26,
SOFDXU_USER_27, SOFDXU_USER_28, SOFDXU_USER_29, SOFDXU_USER_30,
SOFDXU_USER_31, SOFDXU_USER_32, SOFDXU_USER_33, SOFDXU_USER_34,
SOFDXU_USER_35, SOFDXU_USER_36, SOFDXU_USER_37, SOFDXU_USER_38,
SOFDXU_USER_39, SOFDXU_USER_40, SOFDXU_USER_41, SOFDXU_USER_42,
SOFDXU_USER_43, SOFDXU_USER_44, SOFDXU_USER_45, SOFDXU_USER_46,
SOFDXU_USER_47, SOFDXU_USER_48, SOFDXU_USER_49, SOFDXU_USER_50,
SOFDXU_USER_51, SOFDXU_USER_52, SOFDXU_USER_53, SOFDXU_USER_54,
SOFDXU_USER_55, SOFDXU_USER_56, SOFDXU_USER_57, SOFDXU_USER_58,
SOFDXU_USER_59, SOFDXU_USER_60, SOFDXU_USER_61, SOFDXU_USER_62,
SOFDXU_USER_63, SOFDXU_USER_64, SOFDXU_USER_65, SOFDXU_USER_66,
SOFDXU_USER_67, SOFDXU_USER_68, SOFDXU_USER_69, SOFDXU_USER_70,
SOFDXU_USER_71, SOFDXU_USER_72, SOFDXU_USER_73, SOFDXU_USER_74,
SOFDXU_USER_75, SOFDXU_USER_76, SOFDXU_USER_77, SOFDXU_USER_78,
SOFDXU_USER_79, SOFDXU_USER_80 |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON object with created Sales Order.
Error:
400/Request JSON is invalid.
400/Request has no Sales Order Header.
400/Request has no Sales Order Lines.
400/Request Sales Order Line has no SO_LINE_NO.
400/Request Sales Order Comment has no SO_LINE_NO.
400/Request Sales Order Comment has no PRINT_INVOICE.
400/Request Sales Order Extended User has no SO_LINE_NO.
401/AuthToken was not provided.
401/AuthToken is malformed.
401/AuthToken is expired.
401/AuthToken login failure.
500/(Message)
Body contains JSON object with Message and MessageCode.
Returned Sales Order Fields:
ATTACHMENTS, ATTENTION, BILL_NAME, BILL_TO_CUST, CHANGE_CODE, CHANGE_DATE, CHANGE_NO, COMPLETE_ONLY, CONFIRMED_TO, CREATED_BY, CREDIT_LIMIT, CUM_WEIGHT, CURR_CODE, CURR_RATE, CURRENT_BALANCE, CURRENT_ORDERS, CUST_PO_ID, CUSTOMER_ID, CUSTOMER_NAME, CUSTOMER_STATUS, DATE_APPROVED, DATE_CREATED, DATE_LAST_EDI, DATE_LAST_PRINT, DATE_LAST_SHIP, DATE_LAST_UPDT, DATE_MODIFIED, DELAY_DAYS, DELAY_INVOICE, DOM_DIM_WEIGHT, E_MAIL, E_MAIL_DATE, FOB, FREIGHT_CODE, GL_MONTH, GL_YEAR, INT_DIM_WEIGHT, NOTES, MA_GEO, MODIFIED_BY, OPERATOR_ID, ORDER_CLASS, ORDER_DATE, ORDER_DISC_AMT, ORDER_DISC_PCT, ORDER_SUBTOTAL, ORDER_TAKER, ORDER_TAX_2, ORDER_TAX_3, ORDER_TAX_4, ORDER_TAX_5, ORDER_TAX_6, ORDER_TAX_7, ORDER_TAX_8, ORDER_TAX_9, ORDER_TAX_10, ORDER_TAX_AMT, ORDER_TOTAL, ORDER_VAT, PAYMENT_TYPE, REFERENCE, RESALE_ID, RESALE_ID_2, SALES_REGION, SALESMAN_ID, SHIP_METHOD, SHIP_NAME, SHIP_NOTE_1, SHIP_NOTE_2, SHIP_TO_CUST, SLX_CREATE_DATE, SLX_TRANS_DATE, SO_HOLD, SO_ID, SO_STATUS, SO_TYPE, SOFOM_USER_1, SOFOM_USER_2, SOFOM_USER_3, SOFOM_USER_4, SOFOM_USER_5, SOFOM_USER_6, SOFOM_USER_7, SOFOM_USER_8, SOFOM_USER_9, SOFOM_USER_10, SOFOM_USER_11, SOFOM_USER_12, SOFOM_USER_13, SOFOM_USER_14, SOFOM_USER_15, SOFOM_USER_16, SOFOM_USER_17, SOFOM_USER_18, SOFOM_USER_19, SOFOM_USER_20, SOFOM_USER_21, SOFOM_USER_22, SOFOM_USER_23, SOFOM_USER_24, SOFOM_USER_25, SOFOM_USER_26, SOFOM_USER_27, SOFOM_USER_28, SOFOM_USER_29, SOFOM_USER_30, SOFOM_USER_31, SOFOM_USER_32, SOFOM_USER_33, SOFOM_USER_34, SOFOM_USER_35, SOFOM_USER_36, SOFOM_USER_37, SOFOM_USER_38, SOFOM_USER_39, SOFOM_USER_40, SOFOM_USER_41, SOFOM_USER_42, SOFOM_USER_43, SOFOM_USER_44, SOFOM_USER_45, SOFOM_USER_46, SOFOM_USER_47, SOFOM_USER_48, SOFOM_USER_49, SOFOM_USER_50, SOFOM_USER_51, SOFOM_USER_52, SOFOM_USER_53, SOFOM_USER_54, SOFOM_USER_55, SOFOM_USER_56, SOFOM_USER_57, SOFOM_USER_58, SOFOM_USER_59, SOFOM_USER_60, SOFOM_USER_61, SOFOM_USER_62, SOFOM_USER_63, SOFOM_USER_64, SOFOM_USER_65, SOFOM_USER_66, SOFOM_USER_67, SOFOM_USER_68, SOFOM_USER_69, SOFOM_USER_70, SOFOM_USER_71, SOFOM_USER_72, SOFOM_USER_73, SOFOM_USER_74, SOFOM_USER_75, SOFOM_USER_76, SOFOM_USER_77, SOFOM_USER_78, SOFOM_USER_79, SOFOM_USER_80, SOFOM_USER_81, SOFOM_USER_82, SOFOM_USER_83, SOFOM_USER_84, SOFOM_USER_85, SOFOM_USER_86, SOFOM_USER_87, SOFOM_USER_88, TAX_CODE, TERMS_CODE, TIME_LAST_UPDT
Returned Sales Order Line Fields:
AMOUNT, ATP_DATE, BALANCE_DUE, BASE_PRICE, CATG_CODE, CHANGE_CODE, CHANGE_DATE, CHANGE_NO, COMMISSION_PCT, COMPANY_ID, CONFIG_ID, CREATE_PO, CREATED_BY, CURR_CODE, CUST_PART_ID, CUST_PO_LINE, CUSTOMER_NAME, DATE_CREATED, DATE_LAST_ACT, DATE_LAST_QUOTE, DATE_LAST_UPDT, DATE_MODIFIED, DWG_REV, EARLY_SHIP, ECN, EXPECTED_SN, FOB, FREIGHT_CODE, INV_BAL_DUE, INV_ORDER_QTY, INV_RETN_QTY, INV_REVISED_QTY, INV_SHIP_QTY, ITEM_DISC_PCT, JOB_ID, LAST_SHIP_NO, LC_AMOUNT, LC_UNIT_PRICE, LINE_NUMBER, LINE_ORDER_DISC, LINE_OTHER, LINE_TAX_2, LINE_TAX_3, LINE_TAX_4, LINE_TAX_5, LINE_TAX_6, LINE_TAX_7, LINE_TAX_8, LINE_TAX_9, LINE_TAX_10, LINE_TAX_AMT, LINE_VAT, MODIFIED_BY, NEXT_PICK_QTY, OPERATOR_ID, OPTION_TYPE, ORDER_QTY, PACK_SHIP_ID, PART_DESC, PART_ID, PART_UM, PARTIAL_SHIP, PICK_DATE, PICK_PRINT_DATE, PICK_TYPE, PICKED_QTY, PO_ID, PRICE_CODE, PRICE_CONV, PRICE_UM, PRIORITY_CODE, PROD_DISC_AMT1, PROD_DISC_AMT2, PROD_DISC_AMT3, PROD_DISC_CODE1, PROD_DISC_CODE2, PROD_DISC_CODE3, PROD_DISC_TOTAL, PRODUCT_LINE, RA_REASON, REQ_SHIP_DATE, RETURNED_QTY, REV_ORDER_QTY, REV_SHIP_DATE, SALE_CONV, SALE_DEC, SALES_ACCT, SALES_COMM, SALES_DEPT, SALES_REGION, SALESMAN_ID, SCH_SHIP_DATE, SHIP_GROUP, SHIP_METHOD, SHIP_NAME, SHIP_TO_CUST, SHIP_TYPE, SHIPPED_QTY, SLX_TICKET_ID, SN_ENTERED, SN_REQD, SO_DESC, SO_ID, SO_LINE_CAT, SO_LINE_HOLD, SO_LINE_NO, SO_LINE_STATUS, SO_UM, SO_UNIT_COST, SO_UNIT_PRICE, SOFOD_USER_1, SOFOD_USER_2, SOFOD_USER_3, SOFOD_USER_4, SOFOD_USER_5, SOFOD_USER_6, SOFOD_USER_7, SOFOD_USER_8, SOFOD_USER_9, SOFOD_USER_10, SOFOD_USER_11, SOFOD_USER_12, SOFOD_USER_13, SOFOD_USER_14, SOFOD_USER_15, SOFOD_USER_16, STORES_CODE, TAX_CODE, TIME_LAST_UPDT, TO_STORES, VAT_CODE, XREF_SO_ID, XREF_SO_LINE, XREF_TYPE
Returned Sales Order Comment Fields:
COMMENT_TEXT, CREATED_BY, DATE_CREATED, DATE_LAST_UPDT, DATE_MODIFIED, MODIFIED_BY, PRINT_INVOICE, SO_ID, SO_LINE_NO, TIME_LAST_UPDT
Returned Sales Order Extended User Fields:
CREATED_BY, DATE_CREATED, DATE_MODIFIED, MODIFIED_BY, SO_ID, SO_LINE_NO, SOFDXU_USER_1, SOFDXU_USER_2, SOFDXU_USER_3, SOFDXU_USER_4, SOFDXU_USER_5, SOFDXU_USER_6, SOFDXU_USER_7, SOFDXU_USER_8, SOFDXU_USER_9, SOFDXU_USER_10, SOFDXU_USER_11, SOFDXU_USER_12, SOFDXU_USER_13, SOFDXU_USER_14, SOFDXU_USER_15, SOFDXU_USER_16, SOFDXU_USER_17, SOFDXU_USER_18, SOFDXU_USER_19, SOFDXU_USER_20, SOFDXU_USER_21, SOFDXU_USER_22, SOFDXU_USER_23, SOFDXU_USER_24, SOFDXU_USER_25, SOFDXU_USER_26, SOFDXU_USER_27, SOFDXU_USER_28, SOFDXU_USER_29, SOFDXU_USER_30, SOFDXU_USER_31, SOFDXU_USER_32, SOFDXU_USER_33, SOFDXU_USER_34, SOFDXU_USER_35, SOFDXU_USER_36, SOFDXU_USER_37, SOFDXU_USER_38, SOFDXU_USER_39, SOFDXU_USER_40, SOFDXU_USER_41, SOFDXU_USER_42, SOFDXU_USER_43, SOFDXU_USER_44, SOFDXU_USER_45, SOFDXU_USER_46, SOFDXU_USER_47, SOFDXU_USER_48, SOFDXU_USER_49, SOFDXU_USER_50, SOFDXU_USER_51, SOFDXU_USER_52, SOFDXU_USER_53, SOFDXU_USER_54, SOFDXU_USER_55, SOFDXU_USER_56, SOFDXU_USER_57, SOFDXU_USER_58, SOFDXU_USER_59, SOFDXU_USER_60, SOFDXU_USER_61, SOFDXU_USER_62, SOFDXU_USER_63, SOFDXU_USER_64, SOFDXU_USER_65, SOFDXU_USER_66, SOFDXU_USER_67, SOFDXU_USER_68, SOFDXU_USER_69, SOFDXU_USER_70, SOFDXU_USER_71, SOFDXU_USER_72, SOFDXU_USER_73, SOFDXU_USER_74, SOFDXU_USER_75, SOFDXU_USER_76, SOFDXU_USER_77, SOFDXU_USER_78, SOFDXU_USER_79, SOFDXU_USER_80