Backflush Kit Issue, Create
Creates a new Backflush Kit Issue transaction using the supplied data and returns the details of the transaction.
URL
/api/backflush-kit-issue-create
Request Method
POST
Expandable Program
Backflush Kit Issue (ICTBF)
Required Fields
ASSEMBLY_ID
DEPARTMENT
ACCOUNT
DEPARTMENT
ACCOUNT
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
{
"ASSEMBLY_ID": "MOTOR003",
"COMPLETED_QTY": "5",
"TO_STORES": "MA",
"TO_LOCATION": "ISLE 3/SHELF 2",
"DEPARTMENT": "0",
"ACCOUNT": "300",
"SERIAL_NUMBER": "GC00004057,GC00004060:GC00004063",
"AUTH_TOKEN": ""
}Full Request JSON
{
"ACTION_DATE": "",
"EFFECTIVE_DATE": "",
"ASSEMBLY_ID": "",
"ASSEMBLY_LOT": "",
"EXPIRE_DATE": "",
"INCLUDE_SCRAP": "",
"COMPLETED_QTY": "",
"TO_STORES": "",
"TO_LOCATION": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"REFERENCE": "",
"KIT_STORES": "",
"SERIAL_NUMBER": "",
"BATCH_NUMBER": "",
"TXNS_ACCEPTED": "",
"COMPONENTS": [
{
"COMPONENT_ID": "",
"LOT_ID": "",
"STOCK_LOCATION": "",
"SERIAL_NUMBER": ""
}
],
"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.
Components
It is not strictly necessary to include the COMPONENTS array in the request JSON. However, this array should be used if it is necessary to specify a LOT_ID, STOCK_LOCATION or SERIAL_NUMBER for any of the Components. It is only necessary to list the Components for which you need to specify any of these items. All eligible Components will be included in the transaction automatically.
All transacted Components are listed in the COMPONENTS array in the response JSON.
All transacted Components are listed in the COMPONENTS array in the response JSON.
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": "",
"ACTION_TYPE": "",
"EFFECTIVE_DATE": "",
"ASSEMBLY_ID": "",
"PART_DESC": "",
"ASSEMBLY_LOT": "",
"EXPIRE_DATE": "",
"INCLUDE_SCRAP": "",
"COMPLETED_QTY": "",
"PART_UM": "",
"TO_STORES": "",
"TO_LOCATION": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"REFERENCE": "",
"KIT_STORES": "",
"SERIAL_NUMBER": "",
"BATCH_NUMBER": "",
"TXNS_ACCEPTED": "",
"COMPONENTS": [
{
"COMPONENT_ID": "",
"PART_DESC": "",
"KIT_QTY": "",
"PART_UM": "",
"LOT_ID": "",
"STORES_CODE": "",
"STOCK_LOCATION": "",
"MULTI_LOC": "",
"PART_AMT": "",
"SERIAL_NUMBER": ""
}
]
}Failure Response
Returned HTTP status indicates failure:
400/Request JSON is invalid.
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.
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": ""
}