User Tools

Site Tools


webapi_swagger_documentation:57526

S5WebAPISrv 57526

Inventory End Points have been updated to support all of the configured default inventory records and allow for the configuration of prices based on the Price Codes, using Prices, Markups, Margins or Discounts within the bounds of the maximum number of Price Schedules configured in the system. There is no provision to allows the external systems to change the number of Price Schedules.

This functionality is only available in 6.2.7.297 or greater beta release.
In our program and documentation we use the terms “Price level” or “Price Schedule” interchangeably as they are the same thing. A price code determines how the price level is calculated using the RegPricePercentage or SalePricePercentage depending on sale dates.

[GET]/Inventory/{InventoryId}

End Point has been modified to return all of the Pricing information including the Price Code, Description, Prices, Percentage as shown below:

  • “Level”: 0,
  • “Department”: 0,
  • “Regular”: 31.1,
  • “RegPriceCode”: “L”,
  • “RegPriceDesc”: “Markup from Landed”,
  • “RegPricePercent”: 90,
  • “Sale”: 27.28,
  • “SalePriceCode”: “M”,
  • “SalePriceDesc”: “Margin from Landed”,
  • “SalePricePercent”: 40
{
  "Inventory": [
    {
      "InventoryId": 0,
      "PartNumber": "string",
      "ItemNumber": "string",
      "SupplierPartNumber": "string",
      "SubCategory": "string",
      "Prices": [
        {
          "Level": 0,
          "Department": 0,
          "Regular": 0,
          "Sale": 0
        }
      ],
      "VendorId": 0,
      "VendorName": "string",
      "BrandName": "string",
      "Description": "string",
      "Description2": "string",
      "UnitOfMeasure": "string",
      "MarkedDeleted": true,
      "InventoryFreeFormGroup1": [
        {
          "FreeFormData": "string",
          "FreeFormID": 0
        }
      ],
      "InventoryFreeFormGroup2": [
        {
          "FreeFormData": "string",
          "FreeFormID": 0
        }
      ],
      "InventorySellingComment": "string",
      "InventoryInvoiceComment": "string",
      "InventoryWebComment": "string",
      "STA": [
        {
          "STAId": 0,
          "STANumber": "string",
          "Description": "string",
          "Startdate": "2020-01-22T18:20:49.201Z",
          "EndDate": "2020-01-22T18:20:49.201Z",
          "IsActive": true,
          "RetailPrice": 0,
          "CostPrice": 0,
          "BrandId": 0,
          "PartId": 0,
          "MainSTAId": 0,
          "Department": 0
        }
      ],
      "eCommerce": true,
      "KitType": 0,
      "Weight": 0,
      "StartSaleDate": "string",
      "EndSaleDate": "string",
      "AltSupply": [
        {
          "AltSupplyId": 0,
          "InventoryId": 0,
          "SupplierId": 0,
          "Cost": 0,
          "RecordType": "string",
          "SupplierPartNumber": "string",
          "RecordSource": 0,
          "Extra": 0,
          "Freight": 0,
          "Duty": 0,
          "PackSize": "string",
          "SupplierName": "string"
        }
      ],
      "Barcodes": [
        {
          "AltSupplyId": 0,
          "InventoryId": 0,
          "SupplierId": 0,
          "Barcode": "string",
          "SupplierName": "string"
        }
      ],
      "Wholesale": 0,
      "Extra": 0,
      "Freight": 0,
      "Duty": 0,
      "Landed": 0,
      "Measurement1": 0,
      "Measurement2": 0,
      "Size1": "string",
      "Size2": "string",
      "Size3": "string",
      "InStock": 0
    }
  ],
  "InventoryFreeFormHeaders": [
    {
      "FreeFormHeaderName": "string",
      "FreeFormHeaderIsChanged": true,
      "FreeFormID": 0
    }
  ],
  "APIResponse": {
    "IsSuccess": true,
    "Response": "string",
    "ElapsedTime": "string",
    "RecordCount": "string"
  }
}

[POST]Inventory/addInventory

End point has been updated to accept prices based on the same information. External systems can now send pricing that uses the Markup, Margin and Discount calculation methods that are available in System Five.

To assist the external developers, a new End Point has been added to provide the valid Price Codes and their respective meaning.

[Get]Inventory//GetPriceCodes

This returns the following information for use by the developer(s).

  • “SystemFive API Price Codes”: “Inventory”
  • “W”: “Markup from Cost”,
  • “L”: “Markup from Landed”,
  • “D”: “Discount from List”,
  • “F”: “Fixed”,
  • “H”: “Margin from Cost”,
  • “M”: “Margin from Landed”,
  • “S”: “Discount from Sale”,
  • “$”: “Dollar Markup from Landed”,
  • “I”: “Discount from Cash Price Schedule”,
  • “J”: “Markup from Cash Price Schedule”,
  • “K”: “Dollar Markup from Cash Price Schedule”,
  • “ ”: “Not Set”

There are extra fields in the model that are not used by the Price Insert/Update process. Only the

  • “Level”: 0,
  • “Department”: 0,
  • “Regular”: 31.1,
  • “RegPriceCode”: “L”,
  • “RegPricePercent”: 90,
  • “Sale”: 27.28,
  • “SalePriceCode”: “M”,
  • “SalePricePercent”: 40

Regular or RegPricePercent will be used, depending on the RegPriceCode value.

Sale or SalePricePercent will be used, depending on the SalePriceCode value.

Back to webapi_swagger_documentation

webapi_swagger_documentation/57526.txt · Last modified: 2020/01/22 10:26 (4 years ago) by kevin