GET api/StockMovement/DownloadReplenishmentBatch/{batchReference}

This will download a full replenishment batch only including the outstanding items to be fulfilled.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
batchReference

integer

Required

Body Parameters

None.

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":"Successfully downloaded batch 1","Batch":{"BatchReference":0,"CreatedOn":"2025-11-02T12:49:24.2844096+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"?>
<APIReplenishmentBatchResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BatchResult>true</BatchResult>
  <BatchStatus>Successfully downloaded batch 1</BatchStatus>
  <Batch>
    <BatchReference>0</BatchReference>
    <CreatedOn>2025-11-02T12:49:24.2844096+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>
  </Batch>
</APIReplenishmentBatchResponse>