Skip to main content
Skip table of contents

Ship Transfer

You can perform the Ship or Dispatch items for a Transfer Order either in a batch or individually for a particular schedule/task.

For this, first you need to open a warehouse session. This will assign a unique session id.
The response will return affected items with their current warehouse status upon success processing.
Once you are done with your Warehouse Operation you must close the session.

  • You can start the session only after you have fetched the schedule list.

  • On closing of warehouse session, system will sync all status changes to the Order.

POST

End Point: /warehouse/transfers/{recordID}/session/{sessionID}/ship

Sample request payload

CODE
{
 "scandetails":
               [
                {
                 "referencenumber": 0,
                 "warehouseschedulelinerecordid": "string",
                 "assetorproductid": "string",
                 "qty": 0,
                 "containerid": "string"
                }
               ],
 "shipall": true
}

 

Sample Response Payload

If Scan is Successful.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

 If Scan is not Successful.
R2_00018: Not a valid ID

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

 If Scan is not Successful.
R2_00306: Invalid Container ID

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
If any error found in request while processing it, error message will be contextual.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
Invalid Request Parameters

Your 'Request' is responded with the following payload
CODE
{
 "faultCode": 0,
 "faultString": "string",
 "faultDetails":
  {
   "additionalProp1": {},
   "additionalProp2": {},
   "additionalProp3": {}
  }
}

If Scan is not Successful.
Unable to process request because of some Invalid details in request.

Your 'Request' is responded with the following payload
CODE
{
 "faultCode": 0,
 "faultString": "string",
 "faultDetails":
  {
   "additionalProp1": {},
   "additionalProp2": {},
   "additionalProp3": {}
  }
}

If Scan is not Successful.
Internal error, error message will be contextual.

Your 'Request' is responded with the following payload
CODE
{
 "faultCode": 0,
 "faultString": "string",
 "faultDetails":
  {
   "additionalProp1": {},
   "additionalProp2": {},
   "additionalProp3": {}
  }
}

If Scan is not Successful.
RecordID is Incorrect. Please Check.

Your 'Request' is responded with the following payload
CODE
{
 "faultCode": 0,
 "faultString": "string",
 "faultDetails":
  {
   "additionalProp1": {},
   "additionalProp2": {},
   "additionalProp3": {}
  }
}

If Scan is not Successful.
SessionID is Incorrect. Please Check.

Your 'Request' is responded with the following payload
CODE
{
 "faultCode": 0,
 "faultString": "string",
 "faultDetails":
  {
   "additionalProp1": {},
   "additionalProp2": {},
   "additionalProp3": {}
  }
}

If Scan is not Successful.
R2_01258: Warehouse Operations failed. Please try again.

Your 'Request' is responded with the following payload
CODE
{
 "faultCode": 0,
 "faultString": "string",
 "faultDetails":
  {
   "additionalProp1": {},
   "additionalProp2": {},
   "additionalProp3": {}
  }
}

If Scan is not Successful.
R2_01969: This Warehouse task belongs to unsupported schedule type.

Your 'Request' is responded with the following payload
CODE
{
 "faultCode": 0,
 "faultString": "string",
 "faultDetails":
  {
   "additionalProp1": {},
   "additionalProp2": {},
   "additionalProp3": {}
  }
}

If Scan is not Successful.
R2_01259: Order is Locked. Please close and reopen to proceed.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_01319: Order is in use for Filling/ Shipping/ Receiving in Warehouse.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_01990: No valid Item(s) found to ship in this container.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_01991: Some Item(s) in this container could not be shipped.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_01999: Invalid Scan. A valid value is expected for one of these attributes - ‘warehouseschedulelinerecordid’, or ‘assetorproductid’. or ‘containerId’.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_02000: Invalid Scan. Only one of attributes from - ‘warehouseschedulelinerecordid’, or ‘assetorproductid’. or ‘containerId’ is expected.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_02001: No valid Item(s) found to ship.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_02002: Some of the Item(s) could not be shipped.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_02021: Not a valid ‘warehouseschedulelinerecordid’.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_02030: Asset is in use by others.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

If Scan is not Successful.
R2_02031: Item is in use by others.

Your 'Request' is responded with the following payload
CODE
{
 "warehousetransferschedulelines":
                                  [
                                   {
                                    "recordid": "string",
                                    "linenumber": 0,
                                    "levelnumber": 0,
                                    "isformedheader": true,
                                    "status": "Not Available",
                                    "productid": "string",
                                    "assetid": "string",
                                    "description": "string",
                                    "isserial": true,
                                    "iskitheader": true,
                                    "shelflocation": "string",
                                    "binnumber": "string",
                                    "orderedquantity": 0,
                                    "filledquantity": 0,
                                    "shippedquantity": 0,
                                    "receivedquantity": 0,
                                    "containerid": "string",
                                    "transferlinerecordid": "string"
                                   }
                                  ],
 "scanresults":
               [
                {
                 "referencenumber": 0,
                 "faultCode": 0,
                 "faultString": "string",
                 "hint": "string"
                }
               ]
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.