JiwaAPI

<back to all web services

InventoryRegionGETRequest

Requires Authentication
The following routes are available for this service:
GET/Inventory/{InventoryID}/Regions/{RegionName}Retrieves an inventory region.
InventoryRegionGETRequest Parameters:
NameParameterData TypeRequiredDescription
InventoryIDpathstringNo
RegionNamepathstringNo
InventoryRegion Parameters:
NameParameterData TypeRequiredDescription
RegionSupplierOrderingIDformstringNo
OrderEnabledformbool?No
RegionIDformstringNo
RegionNameformstringNo
SuppliersformList<InventorySupplier>No
InventorySupplier Parameters:
NameParameterData TypeRequiredDescription
FXRateformdecimal?No
DefaultSupplierformbool?No
SpareFloat1formdecimal?No
SpareFloat2formdecimal?No
SpareFloat3formdecimal?No
SpareDate1formDateTime?No
SpareDate2formDateTime?No
SpareDate3formDateTime?No
SupplierIDformstringNo
CreditorIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
SupplierPartNoformstringNo
SupplierUPCformstringNo
SpareString1formstringNo
SpareString2formstringNo
SpareString3formstringNo
CustomFieldValuesformList<CustomFieldValue>No
SupplierWarehousesformList<InventorySupplierWarehouse>No
SupplierQuantityPriceBreaksformList<InventorySupplierQuantityPriceBreak>No
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
InventorySupplierWarehouse Parameters:
NameParameterData TypeRequiredDescription
DefaultWarehouseformbool?No
HomeSuppliersCostformdecimal?No
SuppliersCostformdecimal?No
SuppliersCost2formdecimal?No
HomeSuppliersCost2formdecimal?No
SupplierSOHformdecimal?No
DeliveryDaysformint?No
SpareFloat1formdecimal?No
SpareFloat2formdecimal?No
SpareFloat3formdecimal?No
SpareDate1formDateTime?No
SpareDate2formDateTime?No
SpareDate3formDateTime?No
SupplierWarehouseIDformstringNo
CreditorWarehouseIDformstringNo
CreditorWarehouseDescriptionformstringNo
SpareString1formstringNo
SpareString2formstringNo
SpareString3formstringNo
CustomFieldValuesformList<CustomFieldValue>No
UnitOfMeasureformInventoryUnitOfMeasureNo
OrderUnitsformdecimal?No
InventoryUnitOfMeasure Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
InnerUnitOfMeasureformInventoryUnitOfMeasureNo
QuantityInnersPerUnitOfMeasureformdecimal?No
IsSellformbool?No
IsPurchaseformbool?No
ItemNoformint?No
LastSavedDateTimeformDateTime?No
UnitOfMeasureIDformstringNo
NameformstringNo
PartNoformstringNo
BarcodeformstringNo
InventorySupplierQuantityPriceBreak Parameters:
NameParameterData TypeRequiredDescription
QuantityBreakformdecimal?No
Priceformdecimal?No
SupplierQuantityPriceBreakIDformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Inventory/{InventoryID}/Regions/{RegionName} HTTP/1.1 
Host: localhost 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"RegionSupplierOrderingID":"String","OrderEnabled":false,"RegionID":"String","RegionName":"String","Suppliers":[{"FXRate":0,"DefaultSupplier":false,"SpareFloat1":0,"SpareFloat2":0,"SpareFloat3":0,"SpareDate1":"0001-01-01T00:00:00.0000000","SpareDate2":"0001-01-01T00:00:00.0000000","SpareDate3":"0001-01-01T00:00:00.0000000","SupplierID":"String","CreditorID":"String","CreditorAccountNo":"String","CreditorName":"String","SupplierPartNo":"String","SupplierUPC":"String","SpareString1":"String","SpareString2":"String","SpareString3":"String","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"SupplierWarehouses":[{"DefaultWarehouse":false,"HomeSuppliersCost":0,"SuppliersCost":0,"SuppliersCost2":0,"HomeSuppliersCost2":0,"SupplierSOH":0,"DeliveryDays":0,"SpareFloat1":0,"SpareFloat2":0,"SpareFloat3":0,"SpareDate1":"0001-01-01T00:00:00.0000000","SpareDate2":"0001-01-01T00:00:00.0000000","SpareDate3":"0001-01-01T00:00:00.0000000","SupplierWarehouseID":"String","CreditorWarehouseID":"String","CreditorWarehouseDescription":"String","SpareString1":"String","SpareString2":"String","SpareString3":"String","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"UnitOfMeasure":{"RecID":"String","InnerUnitOfMeasure":{"RecID":"String","InnerUnitOfMeasure":{"RecID":"String","QuantityInnersPerUnitOfMeasure":0,"IsSell":false,"IsPurchase":false,"ItemNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","UnitOfMeasureID":"String","Name":"String","PartNo":"String","Barcode":"String"},"QuantityInnersPerUnitOfMeasure":0,"IsSell":false,"IsPurchase":false,"ItemNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","UnitOfMeasureID":"String","Name":"String","PartNo":"String","Barcode":"String"},"QuantityInnersPerUnitOfMeasure":0,"IsSell":false,"IsPurchase":false,"ItemNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","UnitOfMeasureID":"String","Name":"String","PartNo":"String","Barcode":"String"},"OrderUnits":0}],"SupplierQuantityPriceBreaks":[{"QuantityBreak":0,"Price":0,"SupplierQuantityPriceBreakID":"String"}]}]}