PUT api/StockMovement/CreateReplenishmentBatch

This will create a new stock replenishment batch within the system to be fulfilled, based on the data passed.

Request Information

URI Parameters

None.

Body Parameters

Object

None.

Request Formats

application/json, text/json

Sample: 
{"BatchReference":0,"CreatedOn":"2025-10-28T19:10:30.3895157+00:00","CreatedBy":"Test","RequestingBranchList":["Location 1"],"FulfillingBranch":"Location 2","BatchProducts":[{"PLU":"12345678","Description":"Test Product","Amount":10},{"PLU":"87654321","Description":"Test Product 2","Amount":25}],"AutoUpdate":false}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<APIReplenishmentBatch xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BatchReference>0</BatchReference>
  <CreatedOn>2025-10-28T19:10:30.3895157+00:00</CreatedOn>
  <CreatedBy>Test</CreatedBy>
  <RequestingBranchList>
    <anyType xsi:type="xsd:string">Location 1</anyType>
  </RequestingBranchList>
  <FulfillingBranch>Location 2</FulfillingBranch>
  <BatchProducts>
    <APIReplenishmentItem>
      <PLU>12345678</PLU>
      <Description>Test Product</Description>
      <Amount>10</Amount>
    </APIReplenishmentItem>
    <APIReplenishmentItem>
      <PLU>87654321</PLU>
      <Description>Test Product 2</Description>
      <Amount>25</Amount>
    </APIReplenishmentItem>
  </BatchProducts>
  <AutoUpdate>false</AutoUpdate>
</APIReplenishmentBatch>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample: 
{"BatchResult":true,"BatchStatus":"Replenishment Batches have been created under the following ID(s) 123","Batch":null}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<APIReplenishmentBatchResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BatchResult>true</BatchResult>
  <BatchStatus>Replenishment Batches have been created under the following ID(s) 123</BatchStatus>
</APIReplenishmentBatchResponse>