customers itemrates (http://api.3plcentral.com/rels/customers/itemrates)
Resource:
overrides of standard transaction and storage rates, by facility
C# Rel Const:
Rels.CustomerSvc.ItemRates
URI template:
{id}/items/{iid}/rates
Obtain URI from:
Success status: 200; ETag response header supplied; Response is cacheable
Name (* = required) Data Type Description
id * int
iid * int
Type Description
StorageCountScriptTemplateIdentifier Generic.Models.ScriptTemplateIdentifier
Name string
Id int
LegacyStorageCountScriptInfo Generic.Models.InventoryUnitsPer
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
MinCharge decimal? ... used only by scripttemplateids 206 and 207
MonthsToSkipMinCharge int? ... used only by scripttemplateids 206 and 207, skips the specified number of months before applying the min charge
FacilityRates IEnumerable<Customer.Models.FacilityItemRate>
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
XactionRate Customer.Models.XactionItemRate
Policy Customer.Models.ItemRatePolicy item rate policy doc
- 0: NoCharge
- 1: Standard
- 2: Custom
StandardRateSpecifier Customer.Models.XactionStandardRateSpecifier
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
CustomRate Customer.Models.XactionCustomRate
Rate Customer.Models.XactionRate
FreeDays int? ...
SplitFullRate decimal? ...
SplitHalfRate decimal? ...
OrdHandlingRate decimal? ...
RcvHandlingRate decimal? ...
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
StorageRate Customer.Models.StorageItemRate
Policy Customer.Models.ItemRatePolicy item rate policy doc
- 0: NoCharge
- 1: Standard
- 2: Custom
CustomRates IEnumerable<Customer.Models.StorageRate>
CountUnitIdentifier Generic.Models.StorageCountUnitIdentifier
Id string
Name string
Rate decimal
Sample accept: application/hal+json
{
  "storageCountScriptTemplateIdentifier": {
    "name": "str",
    "id": 2
  },
  "legacyStorageCountScriptInfo": {
    "unitIdentifier": {
      "name": "str",
      "id": 2
    },
    "inventoryUnitsPerUnit": 1.0
  },
  "minCharge": 1.0,
  "monthsToSkipMinCharge": 1,
  "facilityRates": [
    {
      "facilityIdentifier": {
        "name": "str",
        "id": 2
      },
      "xactionRate": {
        "policy": 0,
        "standardRateSpecifier": {
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "inventoryUnitsPerUnit": 1.0
        },
        "customRate": {
          "rate": {
            "freeDays": 1,
            "splitFullRate": 1.0,
            "splitHalfRate": 1.0,
            "ordHandlingRate": 1.0,
            "rcvHandlingRate": 1.0
          },
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "inventoryUnitsPerUnit": 1.0
        }
      },
      "storageRate": {
        "policy": 0,
        "customRates": [
          {
            "countUnitIdentifier": {
              "id": "str",
              "name": "str"
            },
            "rate": 1.0
          }
        ]
      }
    }
  ]
}
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int
iid * int
Type Description
StorageCountScriptTemplateIdentifier Generic.Models.ScriptTemplateIdentifier
Name string
Id int
LegacyStorageCountScriptInfo Generic.Models.InventoryUnitsPer
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
MinCharge decimal? ... used only by scripttemplateids 206 and 207
MonthsToSkipMinCharge int? ... used only by scripttemplateids 206 and 207, skips the specified number of months before applying the min charge
FacilityRates IEnumerable<Customer.Models.FacilityItemRate>
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
XactionRate Customer.Models.XactionItemRate
Policy Customer.Models.ItemRatePolicy item rate policy doc
- 0: NoCharge
- 1: Standard
- 2: Custom
StandardRateSpecifier Customer.Models.XactionStandardRateSpecifier
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
CustomRate Customer.Models.XactionCustomRate
Rate Customer.Models.XactionRate
FreeDays int? ...
SplitFullRate decimal? ...
SplitHalfRate decimal? ...
OrdHandlingRate decimal? ...
RcvHandlingRate decimal? ...
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
StorageRate Customer.Models.StorageItemRate
Policy Customer.Models.ItemRatePolicy item rate policy doc
- 0: NoCharge
- 1: Standard
- 2: Custom
CustomRates IEnumerable<Customer.Models.StorageRate>
CountUnitIdentifier Generic.Models.StorageCountUnitIdentifier
Id string
Name string
Rate decimal
Sample content-type: application/hal+json
{
  "storageCountScriptTemplateIdentifier": {
    "name": "str",
    "id": 2
  },
  "legacyStorageCountScriptInfo": {
    "unitIdentifier": {
      "name": "str",
      "id": 2
    },
    "inventoryUnitsPerUnit": 1.0
  },
  "minCharge": 1.0,
  "monthsToSkipMinCharge": 1,
  "facilityRates": [
    {
      "facilityIdentifier": {
        "name": "str",
        "id": 2
      },
      "xactionRate": {
        "policy": 0,
        "standardRateSpecifier": {
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "inventoryUnitsPerUnit": 1.0
        },
        "customRate": {
          "rate": {
            "freeDays": 1,
            "splitFullRate": 1.0,
            "splitHalfRate": 1.0,
            "ordHandlingRate": 1.0,
            "rcvHandlingRate": 1.0
          },
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "inventoryUnitsPerUnit": 1.0
        }
      },
      "storageRate": {
        "policy": 0,
        "customRates": [
          {
            "countUnitIdentifier": {
              "id": "str",
              "name": "str"
            },
            "rate": 1.0
          }
        ]
      }
    }
  ]
}
Type Description
StorageCountScriptTemplateIdentifier Generic.Models.ScriptTemplateIdentifier
Name string
Id int
LegacyStorageCountScriptInfo Generic.Models.InventoryUnitsPer
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
MinCharge decimal? ... used only by scripttemplateids 206 and 207
MonthsToSkipMinCharge int? ... used only by scripttemplateids 206 and 207, skips the specified number of months before applying the min charge
FacilityRates IEnumerable<Customer.Models.FacilityItemRate>
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
XactionRate Customer.Models.XactionItemRate
Policy Customer.Models.ItemRatePolicy item rate policy doc
- 0: NoCharge
- 1: Standard
- 2: Custom
StandardRateSpecifier Customer.Models.XactionStandardRateSpecifier
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
CustomRate Customer.Models.XactionCustomRate
Rate Customer.Models.XactionRate
FreeDays int? ...
SplitFullRate decimal? ...
SplitHalfRate decimal? ...
OrdHandlingRate decimal? ...
RcvHandlingRate decimal? ...
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier
Name string
Id int
InventoryUnitsPerUnit decimal
StorageRate Customer.Models.StorageItemRate
Policy Customer.Models.ItemRatePolicy item rate policy doc
- 0: NoCharge
- 1: Standard
- 2: Custom
CustomRates IEnumerable<Customer.Models.StorageRate>
CountUnitIdentifier Generic.Models.StorageCountUnitIdentifier
Id string
Name string
Rate decimal
Sample accept: application/hal+json
{
  "storageCountScriptTemplateIdentifier": {
    "name": "str",
    "id": 2
  },
  "legacyStorageCountScriptInfo": {
    "unitIdentifier": {
      "name": "str",
      "id": 2
    },
    "inventoryUnitsPerUnit": 1.0
  },
  "minCharge": 1.0,
  "monthsToSkipMinCharge": 1,
  "facilityRates": [
    {
      "facilityIdentifier": {
        "name": "str",
        "id": 2
      },
      "xactionRate": {
        "policy": 0,
        "standardRateSpecifier": {
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "inventoryUnitsPerUnit": 1.0
        },
        "customRate": {
          "rate": {
            "freeDays": 1,
            "splitFullRate": 1.0,
            "splitHalfRate": 1.0,
            "ordHandlingRate": 1.0,
            "rcvHandlingRate": 1.0
          },
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "inventoryUnitsPerUnit": 1.0
        }
      },
      "storageRate": {
        "policy": 0,
        "customRates": [
          {
            "countUnitIdentifier": {
              "id": "str",
              "name": "str"
            },
            "rate": 1.0
          }
        ]
      }
    }
  ]
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.