Shipments Entry, Create
Creates a new Shipments Entry transaction using the supplied data and returns the details of the transaction.
URL
/api/shipments-entry-create
Request Method
POST
Expandable Program
Shipments/Returns Entry (SOTSE)
Required Fields
HEADER:
SO_ID
AUTH_TOKEN
LINES:
SO_LINE_NO
FREIGHT:
AMOUNT
SO_ID
AUTH_TOKEN
LINES:
SO_LINE_NO
FREIGHT:
AMOUNT
Auth Token
This API call requires an Authentication Token ("Auth Token") for the required field AUTH_TOKEN. Auth Tokens are obtained from Auth Token, Get.
Example Request JSON
{
"ACTION_DATE": "2014-11-18",
"SO_ID": "102487",
"REFERENCE": "REF JJ",
"BILL_OF_LADING": "BW-1889-8764252",
"SHIP_VIA": "BEST WAY",
"LINES": [
{
"SO_LINE_NO": "1",
"QUANTITY": "1",
"STORES_CODE": "SH",
"STOCK_LOCATION": "ISLE 2/SHELF 7",
"WEIGHT": "6.50",
"TOTAL_BOXES": "1",
"SERIAL_NUMBER": "GC00004057"
},
{
"SO_LINE_NO": "2",
"QUANTITY": "2",
"STORES_CODE": "SH",
"STOCK_LOCATION": "ISLE 5/SHELF 13",
"WEIGHT": "42.66",
"TOTAL_BOXES": "2",
"SERIAL_NUMBER": "RL00000831,RL00000847"
},
{
"SO_LINE_NO": "3",
"QUANTITY": "5",
"STORES_CODE": "SH",
"STOCK_LOCATION": "ISLE 1/SHELF 9",
"WEIGHT": "243.50",
"TOTAL_BOXES": "5",
"SERIAL_NUMBER": "XR00173865:XR00173869"
},
{
"SO_LINE_NO": "4",
"QUANTITY": "8",
"STORES_CODE": "SH",
"STOCK_LOCATION": "ISLE 11/SHELF 2",
"WEIGHT": "12.25",
"TOTAL_BOXES": "1",
"SERIAL_NUMBER": "JK00043471:JK00043477,JK00043522"
}
],
"FREIGHT": [
{
"AMOUNT": "49.71"
}
],
"AUTH_TOKEN": ""
}Full Request JSON
{
"ACTION_DATE": "",
"SO_ID": "",
"REFERENCE": "",
"BILL_OF_LADING": "",
"SHIP_VIA": "",
"BATCH_NUMBER": "",
"TXNS_ACCEPTED": "",
"LINES": [
{
"SO_LINE_NO": "",
"PART_ID": "",
"LOT_ID": "",
"DWG_REV": "",
"ECN": "",
"REFERENCE": "",
"JOB_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"QUANTITY": "",
"AMOUNT": "",
"STORES_CODE": "",
"STOCK_LOCATION": "",
"MULTI_LOC": "",
"TO_STORES": "",
"TO_LOCATION": "",
"TO_MULTI_LOC": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"BOX_NUMBER": "",
"BILL_OF_LADING": "",
"SHIP_VIA": "",
"SOFST_USER_1": "",
"SOFST_USER_2": "",
"PACK_SHIP_ID": "",
"TOTAL_BOXES": "",
"SERIAL_NUMBER": ""
}
],
"FREIGHT": [
{
"AMOUNT": "",
"LC_AMOUNT": "",
"REFERENCE": "",
"BILL_OF_LADING": "",
"SHIP_VIA": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"BOX_NUMBER": "",
"TOTAL_BOXES": ""
}
],
"AUTH_TOKEN": ""
}Serial Numbers
This transaction uses Serial Numbers. Serial Numbers are specified in the SERIAL_NUMBER field.
A single Serial Number can be specified:
A list of Serial Numbers can be specified:
A range of Serial Numbers can be specified:
A list of single Serial Numbers and Serial Number ranges can be specified:
A single Serial Number can be specified:
"SERIAL_NUMBER": "GC00004057"A list of Serial Numbers can be specified:
"SERIAL_NUMBER": "GC00004057,GC00004058,GC00004059"A range of Serial Numbers can be specified:
"SERIAL_NUMBER": "GC00004057:GC00004059"A list of single Serial Numbers and Serial Number ranges can be specified:
"SERIAL_NUMBER": "GC00004052,GC00004057:GC00004059"Batch Numbers
This transaction uses Batch Numbers.
Batch Numbers are specified in the BATCH_NUMBER field.
Normally a new Batch Number is assigned automatically by the transaction every time it is called and this Batch Number is returned by the transaction.
It is also possible use the same Batch Number across multiple transactions. This is done by passing the Batch Number that is returned from the first call into subsequent calls. This has the advantage of relating multiple transactions to each other, and consuming less Batch Numbers in the system. The scope of what constitutes a "Batch" is up to the API client application developer. In Expandable, the scope of a "Batch" is considered to include all transactions entered by a single operator before closing the transaction window.
It is also possible use the same Batch Number across multiple transactions. This is done by passing the Batch Number that is returned from the first call into subsequent calls. This has the advantage of relating multiple transactions to each other, and consuming less Batch Numbers in the system. The scope of what constitutes a "Batch" is up to the API client application developer. In Expandable, the scope of a "Batch" is considered to include all transactions entered by a single operator before closing the transaction window.
Success Response
Returned HTTP status indicates success:
200/OK
Returned JSON contains the details of the successful transaction:
200/OK
Returned JSON contains the details of the successful transaction:
{
"ACTION_DATE": "",
"SO_ID": "",
"CUSTOMER_ID": "",
"CUSTOMER_NAME": "",
"SHIP_TO_CUST": "",
"SHIP_NAME": "",
"BATCH_NUMBER": "",
"TXNS_ACCEPTED": "",
"LINES": [
{
"SO_LINE_NO": "",
"SHIP_TYPE": "",
"SO_DESC": "",
"SO_UM": "",
"PART_ID": "",
"ACTION_TYPE": "",
"LOT_ID": "",
"DWG_REV": "",
"ECN": "",
"REFERENCE": "",
"JOB_ID": "",
"COMPANY_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"BALANCE_DUE": "",
"QUANTITY": "",
"PART_UM": "",
"INV_QUANTITY": "",
"AMOUNT": "",
"CURR_CODE": "",
"STORES_CODE": "",
"STOCK_LOCATION": "",
"MULTI_LOC": "",
"TO_STORES": "",
"TO_LOCATION": "",
"TO_MULTI_LOC": "",
"RA_REASON": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"BOX_NUMBER": "",
"BILL_OF_LADING": "",
"SHIP_VIA": "",
"SOFST_USER_1": "",
"SOFST_USER_2": "",
"PACK_SHIP_ID": "",
"TOTAL_BOXES": "",
"ON_HAND_QTY": "",
"SERIAL_NUMBER": ""
}
],
"FREIGHT": [
{
"AMOUNT": "",
"CURR_CODE": "",
"LC_AMOUNT": "",
"REFERENCE": "",
"BILL_OF_LADING": "",
"SHIP_VIA": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"BOX_NUMBER": "",
"TOTAL_BOXES": "",
"ZIP_CODE": ""
}
]
}Failure Response
Returned HTTP status indicates failure:
400/Request JSON is invalid.
400/Request has no SO_ID.
400/Request has no Lines or Freight.
400/Request Line has no SO_LINE_NO.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed transaction:
400/Request JSON is invalid.
400/Request has no SO_ID.
400/Request has no Lines or Freight.
400/Request Line has no SO_LINE_NO.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed transaction:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}