api/ShipmentsEntry/Create (POST)
Creates a new Shipments Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields:
ShipmentsEntry: SO_ID
ShipmentsEntryDetail: SO_LINE_NO
ShipmentsEntryFreight: AMOUNT
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Shipments Entry Transaction.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing Shipments Entry Transaction creation data.
Create Shipments Entry Transaction Example:
{
"ShipmentsEntry": {
"ACTION_DATE": "11/18/2014",
"SO_ID": "102487",
"REFERENCE": "REF JJ",
"BILL_OF_LADING": "#1889",
"SHIP_VIA": "BEST WAY"
},
"ShipmentsEntryDetail": [
{
"SO_LINE_NO": "1",
"QUANTITY": "1",
"STORES_CODE": "SH",
"STOCK_LOCATION": "ISLE 2/SHELF 7",
"WEIGHT": "6.41",
"TOTAL_BOXES": "1",
"SERIAL_NUMBER": "GC00004057"
},
{
"SO_LINE_NO": "2",
"QUANTITY": "2",
"STORES_CODE": "SH",
"STOCK_LOCATION": "ISLE 5/SHELF 13",
"WEIGHT": "12.71",
"TOTAL_BOXES": "2",
"SERIAL_NUMBER": "RL00000831,RL00000847"
},
{
"SO_LINE_NO": "3",
"QUANTITY": "5",
"STORES_CODE": "SH",
"STOCK_LOCATION": "ISLE 1/SHELF 9",
"WEIGHT": "243.60",
"TOTAL_BOXES": "5",
"SERIAL_NUMBER": "XR00173865:XR00173869"
},
{
"SO_LINE_NO": "4",
"QUANTITY": "8",
"STORES_CODE": "SH",
"STOCK_LOCATION": "ISLE 11/SHELF 2",
"WEIGHT": "136.16",
"TOTAL_BOXES": "10",
"SERIAL_NUMBER": "JK00043471:JK00043477,JK00043522"
}
],
"ShipmentsEntryFreight": [
{
"AMOUNT": "49.71"
}
]
}
Returns 1 Shipments Entry Transaction if successful.
SERIAL_NUMBER can contain a single Serial Number.
SERIAL_NUMBER can contain multiple Serial Numbers separated by commas.
SERIAL_NUMBER can contain a range of Serial Numbers separated by a colon.
SERIAL_NUMBER can contain any combination of ranges and single Serial Numbers spearated by commas.
Accepted Shipments Entry Fields:
ACTION_DATE, BATCH_NUMBER, BILL_OF_LADING, REFERENCE,
SHIP_VIA, SO_ID
Accepted Shipments Entry Detail Fields:
ACCOUNT, AMOUNT, BILL_OF_LADING, BOX_NUMBER,
DEPARTMENT, DWG_REV, ECN, JOB_ID,
LOT_ID, MULTI_LOC, NUMBER_CARTONS, PART_ID,
QUANTITY, PACK_SHIP_ID, REFERENCE, SERIAL_NUMBER,
SHIP_VIA, SOFST_USER_1, SOFST_USER_2, SO_LINE_NO,
STOCK_LOCATION, STORES_CODE, TO_LOCATION, TO_MULTI_LOC,
TO_STORES, TOTAL_BOXES, WEIGHT
Accepted Shipments Entry Freight Fields:
AMOUNT, BILL_OF_LADING, BOX_NUMBER, LC_AMOUNT,
NUMBER_CARTONS, REFERENCE, SHIP_VIA, TOTAL_BOXES,
WEIGHT |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON object with created Shipments Entry Transaction.
Error:
400/Request JSON is invalid.
400/Request has no Transaction Header.
400/Request has no Transaction Details or Freight.
400/Request Transaction Header has no SO_ID.
400/Request Transaction Detail 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 Shipments Entry Fields:
ACTION_DATE, BATCH_NUMBER, CUSTOMER_ID, CUSTOMER_NAME, CUSTOMER_NAME_ShipTo, SHIP_TO_CUST, SO_ID, TXNS_ACCEPTED
Returned Shipments Entry Detail Fields:
ACCOUNT, ACTION_TYPE, AMOUNT, BALANCE_DUE, BILL_OF_LADING, BOX_NUMBER, COMPANY_ID, CURR_CODE, DEPARTMENT, DWG_REV, ECN, INV_QUANTITY, JOB_ID, LOT_ID, MULTI_LOC, NUMBER_CARTONS, ON_HAND_QTY, PART_ID, PACK_SHIP_ID, PART_UM, QUANTITY, RA_REASON, REFERENCE, SERIAL_NUMBER, SHIP_TYPE, SHIP_VIA, SO_DESC, SOFST_USER_1, SOFST_USER_2, SO_LINE_NO, SO_UM, STOCK_LOCATION, STORES_CODE, TO_LOCATION, TO_MULTI_LOC, TO_STORES, TOTAL_BOXES, WEIGHT
Returned Shipments Entry Freight Fields:
AMOUNT, BILL_OF_LADING, BOX_NUMBER, CURR_CODE, LC_AMOUNT, NUMBER_CARTONS, REFERENCE, SHIP_VIA, TOTAL_BOXES, WEIGHT, ZIP_CODE