Index

api/v1/stocktransfercreate/locationtransfer

Path: api/v1/stocktransfercreate/locationtransfer

Method:POST

Summary:Creates a new Stock Location Transfer

Query Parameters:

QueueOptionalSet to true, 1, or t to queue the request via the Jim2 eBusiness Queue. If specified the response will be 202 Accepted and the B2B request number will be returned.
Leave out, or set to false, 0, or f to process the request immediately.
SubmitRefIdOptionalA unique reference ID for the request. This is used to prevent duplicate requests when the Queue parameter is also passed. If a SubmitRefId is passed via this query parameter and within the request content (see submitRefId in JSON content) then the two values must be the same. A check for duplication due to re-processing on the B2B queue is NOT performed unless the SubmitRefId is included in the request body (ie not passing the SubmitRefId in the message body allows an item on the B2B queue to be reprocessed and potentially creating a duplicate object).
The Queue parameter must also be specified if SubmitRefId is specified.
Note that the SubmitRefId must be unique to Jim2, so if multiple systems are making calls care must be taken to avoid clashes in SubmitRefIds between systems.

Request content:

{
The location code where the stock is transferred from.
"fromLocation":string
The location code where the stock is transferred to.
"toLocation":string
The date due for the new Stock Transfer. Must be in ISO date format - eg "2020-01-31".
optional
"dateDue":string
The status for the Stock Transfer. This status must be valid per workflow from Booked, and cannot be Transfer or FINISH. If omitted the Status will be 'Booked'.
optional
"status":string
Any notes relating to the Stock Transfer
optional
"notes":string
The branch code. Branches must be enabled.
optional
"branch":string
optional
"comments": [{
"comment":string
}]
"stockLines": [{
The Jim2 stock code (the Jim2 stock the user is transferring).
"stockCode":string
The stock description. Only required if the default stock description needs to be overrridden. It is recommended this be set for special stock.
optional
"stockDescription":string
The number of items inside the Unit. If omitted the qty will be set to 1. Eg, 12 (BOX containing 12 items)'.
optional
"unitQty":number
How many units of the stock should be transferred.
"qty":number
}]
A unique reference for the create request. This reference must be unique for each object and can be used to ensure duplicate objects are not created when re-trying API calls. Note this reference must be unique in Jim2, so if multiple systems are creating objects care must be taken to avoid clashes between the different system's submit ref id. Refer also to the SubmitRefId url query parameter for relevant endpoints.
optional
"submitRefID":string
Used where custom processing is required and additional data must be passed to that custom processing.
optional
"custom":any
}

Response content:

{
"transferNo":integer
}