PUT api/StockMovement/CompleteReplenishmentBatch

This will complete the stock replenishment batch which will fulfill the order meaning it can no longer be downloaded or changed.

Request Information

URI Parameters

None.

Body Parameters

Object

None.

Request Formats

application/json, text/json

Sample: 
{"BatchReference":0,"CreatedOn":"2025-05-10T00:10:04.4097832+01: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":true}

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-05-10T00:10:04.4097832+01: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>true</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":"Batch ID: 1 has been updated and marked as completed","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>Batch ID: 1 has been updated and marked as completed</BatchStatus>
</APIReplenishmentBatchResponse>