Gets the catalog entry inventory of specific warehouse.

1 min

GET

http://localhost:64424/episerverapi/commerce/entries/{entryCode}/inventories/{warehouseCode}

Path Parameters

entryCodestringrequired
Description
The entry code.
warehouseCodestringrequired
Description
The warehouse code.

Responses

200Return the warehouse inventory.

EPiServer.ServiceApi.Commerce.Models.Catalog.WarehouseInventory
- CatalogEntryCodestring
  Description
  Gets the catalog entry key.
- WarehouseCodestring
  Description
  Represents the unique warehouse code.
- WarehouseLinkEPiServer.ServiceApi.Models.ResourceLink
  Description
  Class that represents linkage and more information about models.
  - Titlestring
    Description
    Gets or sets the title.
  - Typestring
    Description
    Gets or sets the type.
  - Hrefstring
    Description
    Gets or sets the uri.
  - PropertiesEPiServer.ServiceApi.Models.NameValue[]
    Description
    Gets or sets the properties.
    - Namestring
      Description
      Gets or sets the name.
    - Valuestring
      Description
      Gets or sets the type.
- InStockQuantitynumber<double>
  Description
  Represents the inventory's in-stock quantity.
  Format
  double
- ReservedQuantitynumber<double>
  Description
  Represents the inventory's reserved quantity.
  Format
  double
- ReorderMinQuantitynumber<double>
  Description
  Represents the inventory's minimum re-order quantity.
  Format
  double
- PreorderQuantitynumber<double>
  Description
  Represents the inventory's pre-order quantity.
  Format
  double
- BackorderQuantitynumber<double>
  Description
  Represents the inventory's backorder quantity.
  Format
  double
- AllowBackorderboolean
  Description
  Represents whether to allow backorders.
- AllowPreorderboolean
  Description
  Represents whether to allow pre-orders.
- InventoryStatusstring
  Description
  Indicates whether or not current inventory amount is used in determining if an order can be completed.
- PreorderAvailabilityDatestring<date-time>
  Description
  Represents the availability date for the inventory's pre-orders.
  Format
  date-time
- BackorderAvailabilityDatestring<date-time>
  Description
  Represents the availability date for the inventory's backorders.
  Format
  date-time
- PurchaseAvailableDatestring<date-time>
  Description
  Represents the availability date for the inventory's purchase.
  Format
  date-time

401If user does not have enough permission for this request.

404If entry or warehouse inventory does not exist.

curl

curl --request GET \
     --url http://localhost:64424/episerverapi/commerce/entries/{entryCode}/inventories/{warehouseCode} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("http://localhost:64424/episerverapi/commerce/entries/{entryCode}/inventories/{warehouseCode}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("http://localhost:64424/episerverapi/commerce/entries/{entryCode}/inventories/{warehouseCode}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "http://localhost:64424/episerverapi/commerce/entries/{entryCode}/inventories/{warehouseCode}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Return the warehouse inventory.
{
  "CatalogEntryCode": "",
  "WarehouseCode": "",
  "WarehouseLink": {
    "Title": "",
    "Type": "",
    "Href": "",
    "Properties": [
      {
        "Name": "",
        "Value": ""
      }
    ]
  },
  "InStockQuantity": "",
  "ReservedQuantity": "",
  "ReorderMinQuantity": "",
  "PreorderQuantity": "",
  "BackorderQuantity": "",
  "AllowBackorder": false,
  "AllowPreorder": false,
  "InventoryStatus": "",
  "PreorderAvailabilityDate": "",
  "BackorderAvailabilityDate": "",
  "PurchaseAvailableDate": ""
}

401

// If user does not have enough permission for this request.

404

// If entry or warehouse inventory does not exist.