Resource

https://api.warehousefs.com/public/v1/stock-reservations/{merchantCode}/{merchantIdentifier}

The stock reservations resource allows the merchant to create, update, and delete reservations of stock in the system. A stock reservation increased the "Quantity Reserved" counter for any items contained within it. It is a convenient way to quickly reserve stock in the system for any reason without submitting a fully validated fulfillment request submission, and it is useful for merchants with e-commerce systems that do not manage inventory allocation locally.

PUT

Request

URL Template

The {merchantCode} field in the URL template should be replaced with the merchant code for whom the stock reservation will belong to.

The {merchantIdentifier} field in the URL should contain the merchant's identifier for the request. In many cases, the merchant's e-commerce systems' order number is a good value to put here.

Example Request URL

https://api.warehousefs.com/public/v1/stock-reservations/CONTOSO/129834478

Query Parameters

No query parameters may be included in the request.

Entity Body

The entity body is an XML document that represents the stock reservation. If a stock reservation with the given merchant code and merchant identifier already exists, then it will be released, deleted, and replaced by the one specified in the entity body.

Example Request Entity Body

<?xml version="1.0" encoding="utf-8"?>
<StockReservation xmlns="urn:WarehouseFS-1.0">
  <State>ACQUIRED</State> <-- (1) -->
  <Note>Submitted via the WFS Integrator plug-in.</Note> <-- (2) -->
  <Lines> <-- (3) -->
    <Line>
      <Item>
        <MerchantIdentifier>4013-BLACK-S</MerchantIdentifier>
      </Item> 
      <Quantity>2</Quantity>
    </Line>
    <Line>
      <Item>
        <MerchantIdentifier>4036-BLACK-XL</MerchantIdentifier>
      </Item>
      <Quantity>1</Quantity>
    </Line>
  </Lines>
</StockReservation>

1. The state in which the stock reservation will be created. The two possible states are ACQUIRED (in which the system will immediately try to reserve all of the stock) and NOT-ACQUIRED (in which the system will create the stock reservation but not actually try to reserve all of the stock). If the ACQUIRED state is specified and reservation of stock fails, then the reservation will still be created in the NOT-ACQUIRED state.
2. One can provide a brief, human-readable note about the nature and purpose of the stock reservation.
3. Each <Line /> element describes the inventory that should be reserved.

Response

If successful, the API will return 200 OK and an empty entity body.

If any error occurs, the HTTP status code will not be 200 OK. An <Errors /> element may be present in the entity body.

DELETE

Request

URL Template

The {merchantCode} field in the URL template should be replaced with the merchant code for whom the stock reservation will belong to.

The {merchantIdentifier} field in the URL should contain the merchant's identifier for the request. In many cases, the merchant's e-commerce systems' order number is a good value to put here.

Example Request URL

https://api.warehousefs.com/public/v1/stock-reservations/CONTOSO/129834478

Query Parameters

No query parameters may be included in the request.

Entity Body

No entity body may be included in the request.

Response

If successful, the API will return 200 OK and an empty entity body. This indicates that the stock reservation was found, released (if necessary), and deleted from the system.

If any error occurs, the HTTP status code will not be 200 OK. An <Errors /> element may be present in the entity body.