POST api/scalelocations

Creates or updates a single ScaleLocation

Request Information

URI Parameters

None.

Body Parameters

ScaleLocation
NameDescriptionTypeAdditional information
ID

integer

None.

DeptNo

Incremental Department ID

integer

None.

DeptCode

Department Code

string

None.

Name

Display name

string

None.

Enabled

boolean

None.

Updated

date

None.

Department

Department

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "deptNo": 1,
  "deptCode": "sample string 2",
  "name": "sample string 3",
  "enabled": true,
  "updated": "2025-06-14T06:05:47.6012513",
  "department": {
    "$id": "2",
    "id": 1,
    "name": "sample string 2",
    "code": "sample string 3",
    "sortOrder": 4,
    "isLiquor": true,
    "isTobacco": true,
    "excludeTalker": true,
    "externalSales": true,
    "saleGLCode": "sample string 9",
    "cogsglCode": "sample string 10",
    "accountingCategoryID": 11,
    "maximumMarkdownPercentage": 12.0,
    "accountingOnly": true,
    "generateExternalID": 1,
    "useNonReportableTaxCode": true,
    "minPLU": 15,
    "maxPLU": 16,
    "scaleLocation": {
      "$ref": "1"
    },
    "subDepartments": [
      {
        "$id": "3",
        "id": 1,
        "departmentID": 2,
        "name": "sample string 3",
        "code": "sample string 4",
        "departmentCode": "sample string 5",
        "externalSales": true,
        "minorDepartments": [
          {
            "$id": "4",
            "id": 1,
            "subDepartmentID": 2,
            "departmentID": 3,
            "name": "sample string 4",
            "subDepartmentCode": "sample string 5",
            "departmentCode": "sample string 6",
            "code": "sample string 7",
            "lesserDepartments": [
              {
                "$id": "5",
                "id": 1,
                "departmentID": 2,
                "subDepartmentID": 3,
                "minorDepartmentID": 4,
                "name": "sample string 5",
                "code": "sample string 6",
                "departmentCode": "sample string 7",
                "subDepartmentCode": "sample string 8",
                "minorDepartmentCode": "sample string 9",
                "updated": "2025-06-14T06:05:47.6012513",
                "salesMode": 1,
                "gstPercent": 1,
                "costGSTPercent": 1,
                "earnLoyaltyPoints": true,
                "quantityOverride": true,
                "quantityRequired": true,
                "allowDiscounts": true,
                "discountDiscounts": true,
                "itemRecalled": true,
                "noRefund": true,
                "active": true,
                "allowMarkdown": true,
                "defaultGP": 1.1,
                "labelShelfDefault": 1,
                "labelTalkerDefault": 1,
                "labelSmall": true,
                "tags": "sample string 11",
                "unitMeasureKind": 1,
                "fuelItem": true,
                "trackSerial": true,
                "warrantyPeriod": 1,
                "costCalcMethod": 1,
                "providerName": "sample string 12",
                "overrideHostMargin": true,
                "keepDescription": true,
                "mscCommodity": "sample string 15",
                "allowAutoOrder": true,
                "excludeFromWebUpdate": true,
                "webPriceBasedOn": true,
                "labelFormat": "sample string 16",
                "sendToScale": true,
                "labelPageLayoutG_UID": "tt8YeaqCBECW/paHztQM7w==",
                "labelPageLayoutGuid": "7918dfb6-82aa-4004-96fe-9687ced40cef",
                "minimumAge": 17,
                "countryOfOrigin": "sample string 18",
                "serviceFeeID": 1,
                "eftCode": 19,
                "defaultPrinter": "sample string 20",
                "defaultPrinterGroup": "sample string 21",
                "buyingLimit": 1,
                "buyingLimitIndependent": true,
                "buyingLimitType": 0,
                "includeInDistinctLimit": true,
                "defaultsEmpty": false,
                "mscCat": {
                  "$id": "6",
                  "dept": 1,
                  "category": 2,
                  "name": "sample string 3",
                  "active": true,
                  "mscCommodities": [
                    {
                      "$id": "7",
                      "dept": 1,
                      "category": 2,
                      "commodity": 3,
                      "name": "sample string 4",
                      "active": true,
                      "mscSubCommodities": [
                        {
                          "$id": "8",
                          "dept": 1,
                          "category": 2,
                          "commodity": 3,
                          "subCommodity": 4,
                          "name": "sample string 5",
                          "active": true,
                          "subCommodityCode": "sample string 7"
                        },
                        {
                          "$ref": "8"
                        }
                      ],
                      "commodityCode": "sample string 6"
                    },
                    {
                      "$ref": "7"
                    }
                  ],
                  "categoryCode": "sample string 5"
                },
                "mscCom": {
                  "$ref": "7"
                },
                "mscDep": {
                  "$id": "9",
                  "dept": 1,
                  "name": "sample string 2",
                  "active": true,
                  "mscCategories": [
                    {
                      "$ref": "6"
                    },
                    {
                      "$ref": "6"
                    }
                  ],
                  "deptCode": "sample string 4"
                },
                "mscSubCom": {
                  "$ref": "8"
                }
              },
              {
                "$ref": "5"
              }
            ],
            "updated": "2025-06-14T06:05:47.6012513",
            "salesMode": 1,
            "gstPercent": 1,
            "costGSTPercent": 1,
            "earnLoyaltyPoints": true,
            "quantityOverride": true,
            "quantityRequired": true,
            "allowDiscounts": true,
            "discountDiscounts": true,
            "itemRecalled": true,
            "noRefund": true,
            "active": true,
            "allowMarkdown": true,
            "defaultGP": 1.1,
            "labelShelfDefault": 1,
            "labelTalkerDefault": 1,
            "labelSmall": true,
            "tags": "sample string 9",
            "unitMeasureKind": 1,
            "fuelItem": true,
            "trackSerial": true,
            "warrantyPeriod": 1,
            "costCalcMethod": 1,
            "providerName": "sample string 10",
            "overrideHostMargin": true,
            "keepDescription": true,
            "mscCommodity": "sample string 13",
            "allowAutoOrder": true,
            "excludeFromWebUpdate": true,
            "webPriceBasedOn": true,
            "labelFormat": "sample string 14",
            "sendToScale": true,
            "labelPageLayoutG_UID": "r0/Rrl8jb0i2vKRou7VYJg==",
            "labelPageLayoutGuid": "aed14faf-235f-486f-b6bc-a468bbb55826",
            "minimumAge": 15,
            "countryOfOrigin": "sample string 16",
            "serviceFeeID": 1,
            "eftCode": 17,
            "defaultPrinter": "sample string 18",
            "defaultPrinterGroup": "sample string 19",
            "buyingLimit": 1,
            "buyingLimitIndependent": true,
            "buyingLimitType": 0,
            "includeInDistinctLimit": true,
            "defaultsEmpty": false,
            "mscCat": {
              "$ref": "6"
            },
            "mscCom": {
              "$ref": "7"
            },
            "mscDep": {
              "$ref": "9"
            },
            "mscSubCom": {
              "$ref": "8"
            }
          },
          {
            "$ref": "4"
          }
        ],
        "investmentBuyOverride": true,
        "updated": "2025-06-14T06:05:47.6012513",
        "salesMode": 1,
        "gstPercent": 1,
        "costGSTPercent": 1,
        "earnLoyaltyPoints": true,
        "quantityOverride": true,
        "quantityRequired": true,
        "allowDiscounts": true,
        "discountDiscounts": true,
        "itemRecalled": true,
        "noRefund": true,
        "active": true,
        "allowMarkdown": true,
        "defaultGP": 1.1,
        "labelShelfDefault": 1,
        "labelTalkerDefault": 1,
        "labelSmall": true,
        "tags": "sample string 9",
        "unitMeasureKind": 1,
        "fuelItem": true,
        "trackSerial": true,
        "warrantyPeriod": 1,
        "costCalcMethod": 1,
        "providerName": "sample string 10",
        "overrideHostMargin": true,
        "keepDescription": true,
        "mscCommodity": "sample string 13",
        "allowAutoOrder": true,
        "excludeFromWebUpdate": true,
        "webPriceBasedOn": true,
        "labelFormat": "sample string 14",
        "sendToScale": true,
        "labelPageLayoutG_UID": "HmdTc+8yJkyoDC8Mze/ZJA==",
        "labelPageLayoutGuid": "7353671e-32ef-4c26-a80c-2f0ccdefd924",
        "minimumAge": 15,
        "countryOfOrigin": "sample string 16",
        "serviceFeeID": 1,
        "eftCode": 17,
        "defaultPrinter": "sample string 18",
        "defaultPrinterGroup": "sample string 19",
        "buyingLimit": 1,
        "buyingLimitIndependent": true,
        "buyingLimitType": 0,
        "includeInDistinctLimit": true,
        "defaultsEmpty": false,
        "mscCat": {
          "$ref": "6"
        },
        "mscCom": {
          "$ref": "7"
        },
        "mscDep": {
          "$ref": "9"
        },
        "mscSubCom": {
          "$ref": "8"
        }
      },
      {
        "$ref": "3"
      }
    ],
    "stores": [
      1,
      2
    ],
    "investmentBuyOverride": true,
    "updated": "2025-06-14T06:05:47.6012513",
    "salesMode": 1,
    "gstPercent": 1,
    "costGSTPercent": 1,
    "earnLoyaltyPoints": true,
    "quantityOverride": true,
    "quantityRequired": true,
    "allowDiscounts": true,
    "discountDiscounts": true,
    "itemRecalled": true,
    "noRefund": true,
    "active": true,
    "allowMarkdown": true,
    "defaultGP": 1.1,
    "labelShelfDefault": 1,
    "labelTalkerDefault": 1,
    "labelSmall": true,
    "tags": "sample string 19",
    "unitMeasureKind": 1,
    "fuelItem": true,
    "trackSerial": true,
    "warrantyPeriod": 1,
    "costCalcMethod": 1,
    "providerName": "sample string 20",
    "overrideHostMargin": true,
    "keepDescription": true,
    "mscCommodity": "sample string 23",
    "allowAutoOrder": true,
    "excludeFromWebUpdate": true,
    "webPriceBasedOn": true,
    "labelFormat": "sample string 24",
    "sendToScale": true,
    "labelPageLayoutG_UID": "45J9j0gMMkG5sjJWDA0zAA==",
    "labelPageLayoutGuid": "8f7d92e3-0c48-4132-b9b2-32560c0d3300",
    "minimumAge": 25,
    "countryOfOrigin": "sample string 26",
    "serviceFeeID": 1,
    "eftCode": 27,
    "defaultPrinter": "sample string 28",
    "defaultPrinterGroup": "sample string 29",
    "buyingLimit": 1,
    "buyingLimitIndependent": true,
    "buyingLimitType": 0,
    "includeInDistinctLimit": true,
    "defaultsEmpty": false,
    "mscCat": {
      "$ref": "6"
    },
    "mscCom": {
      "$ref": "7"
    },
    "mscDep": {
      "$ref": "9"
    },
    "mscSubCom": {
      "$ref": "8"
    }
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.