REL documentation
customers itemexchanges (http://api.3plcentral.com/rels/customers/itemexchanges)
Resource:
GroupOperator: items update via exchange format
C# Rel Const:
Rels.CustomerSvc.ItemExchangeList
URI template:
{id}/itemexchanger{?pgsiz,pgnum,rql,sort,isimperial,validateonly}
Obtain URI from:
Billboard
To modify batches of item records, Use Accept: text/csv;separator=tab to output a file; then input the file, modified as desired, using PUT Rels.CustomerSvc.ItemExchangeList.
Success status: 200
Name (* = required) Data Type Description
id * int customer id
pgsiz int must be positive; limit 2000, specifying more is an error; default 2000; max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
isimperial bool
Type Description
TotalResults int
ResourceList IList<Customer.Models.ItemExchange>
Sku string
Description string
Description2 string
Min decimal? ...
Max decimal? ...
CycleCount int? ...
ReorderQty decimal? ...
InventoryMethod string
Temperature decimal? ...
Cost decimal? ...
Upc string
IsTrackLotNumber bool? ...
IsTrackSerialNumber bool? ...
IsTrackExpirationDate bool? ...
LabelingUnitType string
LabelingUnitQty decimal? ...
LabelingUnitLength decimal? ...
LabelingUnitWidth decimal? ...
LabelingUnitHeight decimal? ...
LabelingUnitWeight decimal? ...
LabelingUnitNetWeight decimal? ...
InventoryUnitOfMeasureType string
SecondaryUnitOfMeasureType string
InventoryUnitsPerSecondUnit decimal? ...
Nmfc string
IsTrackLotNumberRequired bool? ...
IsTrackSerialNumberRequired bool? ...
IsTrackSerialNumberUnique bool? ...
IsTrackExpirationDateRequired bool? ...
IsPickLotNumberRequired bool
IsPickSerialNumberRequired bool
IsPickExpirationDateRequired bool
IsTrackCost bool? ...
IsTrackCostRequired bool? ...
MovableUnitDescription string
MovableUnitTie decimal? ...
MovableUnitHigh decimal? ...
MovableUnitQty decimal? ...
MovableUnitLength decimal? ...
MovableUnitWidth decimal? ...
MovableUnitHeight decimal? ...
MovableUnitWeight decimal? ...
Active bool? ...
StorageUoms IEnumerable<Customer.Models.ItemExchangeXactionStdRate>
FacilityName string
UomName string
InventoryUnitsPerUnit decimal
RenameSku string This value is only used on PUT: on input, it replaces Sku; on output it is null unless Sku was replaced in which case it is the original Sku value
IsHazMat bool? ...
HazMatId string
HazMatShippingName string
HazMatHazardClass string
HazMatPackingGroup string
HazMatFlashPoint string
HazMatLabelCode string
HazMatFlag string
StorageUnitOfMeasure string
InventoryUnitsPerStorageUnit decimal? ...
StorageCountScriptTemplateId int? ...
ItemFacilityStorageRates IEnumerable<Customer.Models.ItemExchangeStorageRate>
FacilityName string
CountUnitDescription string
Rate decimal
OutboundMobileSerializationBehavior Common.Enum.OutboundMobileSerializationBehavior? ...
- 0: Disabled
- 1: IgnoreQuantityMismatches
- 2: DisallowQuantityMismatches
Price decimal? ...
Classification string
CountryOfManufacture string
HarmonizedCode string
InventoryCategory string
StorageRates IEnumerable<Customer.Models.ItemExchangeXactionCustomRate>
FacilityName string
UomName string
InventoryUnitsPerUnit decimal
StorageSplitFullRate decimal? ...
StorageSplitHalfRate decimal? ...
StorageFreeDays int? ...
RcvHandlingRate decimal? ...
OrdHandlingRate decimal? ...
LocationZones string
MovableUnitLocationZones string
OverAllocLocationZones string
PreferredLocationId int? ...
ForceIntoPreferredLocation bool? ...
AllowMixedItemStorage bool? ...
AllowMixedLotStorage bool? ...
MixedExpirationDaysThreshold int? ...
LabelingUnitUpc string
MovableUnitUpc string
SecondaryUnitUpc string
StorageChargeMin decimal? ...
StorageChargeMinMonthsToSkip int? ...
AutoHoldExpirationDaysThreshold int? ...
MaxToAllocateFromPickline decimal? ...
PicklineMin decimal? ...
PicklineMax decimal? ...
Replenishment bool
Links IList<WebApi.Hal.Link>
- /rels/customers/item
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "item": [
      {
        "sku": "str",
        "description": "str",
        "description2": "str",
        "min": 1.0,
        "max": 1.0,
        "cycleCount": 1,
        "reorderQty": 1.0,
        "inventoryMethod": "str",
        "temperature": 1.0,
        "cost": 1.0,
        "upc": "str",
        "isTrackLotNumber": true,
        "isTrackSerialNumber": true,
        "isTrackExpirationDate": true,
        "labelingUnitType": "str",
        "labelingUnitQty": 1.0,
        "labelingUnitLength": 1.0,
        "labelingUnitWidth": 1.0,
        "labelingUnitHeight": 1.0,
        "labelingUnitWeight": 1.0,
        "labelingUnitNetWeight": 1.0,
        "inventoryUnitOfMeasureType": "str",
        "secondaryUnitOfMeasureType": "str",
        "inventoryUnitsPerSecondUnit": 1.0,
        "nmfc": "str",
        "isTrackLotNumberRequired": true,
        "isTrackSerialNumberRequired": true,
        "isTrackSerialNumberUnique": true,
        "isTrackExpirationDateRequired": true,
        "isPickLotNumberRequired": true,
        "isPickSerialNumberRequired": true,
        "isPickExpirationDateRequired": true,
        "isTrackCost": true,
        "isTrackCostRequired": true,
        "movableUnitDescription": "str",
        "movableUnitTie": 1.0,
        "movableUnitHigh": 1.0,
        "movableUnitQty": 1.0,
        "movableUnitLength": 1.0,
        "movableUnitWidth": 1.0,
        "movableUnitHeight": 1.0,
        "movableUnitWeight": 1.0,
        "active": true,
        "storageUoms": [
          {
            "facilityName": "str",
            "uomName": "str",
            "inventoryUnitsPerUnit": 3.0
          }
        ],
        "renameSku": "str",
        "isHazMat": true,
        "hazMatId": "str",
        "hazMatShippingName": "str",
        "hazMatHazardClass": "str",
        "hazMatPackingGroup": "str",
        "hazMatFlashPoint": "str",
        "hazMatLabelCode": "str",
        "hazMatFlag": "str",
        "storageUnitOfMeasure": "str",
        "inventoryUnitsPerStorageUnit": 1.0,
        "storageCountScriptTemplateId": 1,
        "itemFacilityStorageRates": [
          {
            "facilityName": "str",
            "countUnitDescription": "str",
            "rate": 3.0
          }
        ],
        "outboundMobileSerializationBehavior": 0,
        "price": 1.0,
        "classification": "str",
        "countryOfManufacture": "str",
        "harmonizedCode": "str",
        "inventoryCategory": "str",
        "storageRates": [
          {
            "facilityName": "str",
            "uomName": "str",
            "inventoryUnitsPerUnit": 3.0,
            "storageSplitFullRate": 1.0,
            "storageSplitHalfRate": 1.0,
            "storageFreeDays": 1,
            "rcvHandlingRate": 1.0,
            "ordHandlingRate": 1.0
          }
        ],
        "locationZones": "str",
        "movableUnitLocationZones": "str",
        "overAllocLocationZones": "str",
        "preferredLocationId": 1,
        "forceIntoPreferredLocation": true,
        "allowMixedItemStorage": true,
        "allowMixedLotStorage": true,
        "mixedExpirationDaysThreshold": 1,
        "labelingUnitUpc": "str",
        "movableUnitUpc": "str",
        "secondaryUnitUpc": "str",
        "storageChargeMin": 1.0,
        "storageChargeMinMonthsToSkip": 1,
        "autoHoldExpirationDaysThreshold": 1,
        "maxToAllocateFromPickline": 1.0,
        "picklineMin": 1.0,
        "picklineMax": 1.0,
        "replenishment": true
      }
    ]
  }
}
To modify batches of item records. Use Content-Type: text/csv;separator=tab.
Success status: 200
Name (* = required) Data Type Description
id * int customer id
isimperial bool
validateonly bool If "true", the output contains the first 10 records in the batch; if "false" the output is an empty list
Type Description
TotalResults int
ResourceList IList<Customer.Models.ItemExchange>
Sku string
Description string
Description2 string
Min decimal? ...
Max decimal? ...
CycleCount int? ...
ReorderQty decimal? ...
InventoryMethod string
Temperature decimal? ...
Cost decimal? ...
Upc string
IsTrackLotNumber bool? ...
IsTrackSerialNumber bool? ...
IsTrackExpirationDate bool? ...
LabelingUnitType string
LabelingUnitQty decimal? ...
LabelingUnitLength decimal? ...
LabelingUnitWidth decimal? ...
LabelingUnitHeight decimal? ...
LabelingUnitWeight decimal? ...
LabelingUnitNetWeight decimal? ...
InventoryUnitOfMeasureType string
SecondaryUnitOfMeasureType string
InventoryUnitsPerSecondUnit decimal? ...
Nmfc string
IsTrackLotNumberRequired bool? ...
IsTrackSerialNumberRequired bool? ...
IsTrackSerialNumberUnique bool? ...
IsTrackExpirationDateRequired bool? ...
IsPickLotNumberRequired bool
IsPickSerialNumberRequired bool
IsPickExpirationDateRequired bool
IsTrackCost bool? ...
IsTrackCostRequired bool? ...
MovableUnitDescription string
MovableUnitTie decimal? ...
MovableUnitHigh decimal? ...
MovableUnitQty decimal? ...
MovableUnitLength decimal? ...
MovableUnitWidth decimal? ...
MovableUnitHeight decimal? ...
MovableUnitWeight decimal? ...
Active bool? ...
StorageUoms IEnumerable<Customer.Models.ItemExchangeXactionStdRate>
FacilityName string
UomName string
InventoryUnitsPerUnit decimal
RenameSku string This value is only used on PUT: on input, it replaces Sku; on output it is null unless Sku was replaced in which case it is the original Sku value
IsHazMat bool? ...
HazMatId string
HazMatShippingName string
HazMatHazardClass string
HazMatPackingGroup string
HazMatFlashPoint string
HazMatLabelCode string
HazMatFlag string
StorageUnitOfMeasure string
InventoryUnitsPerStorageUnit decimal? ...
StorageCountScriptTemplateId int? ...
ItemFacilityStorageRates IEnumerable<Customer.Models.ItemExchangeStorageRate>
FacilityName string
CountUnitDescription string
Rate decimal
OutboundMobileSerializationBehavior Common.Enum.OutboundMobileSerializationBehavior? ...
- 0: Disabled
- 1: IgnoreQuantityMismatches
- 2: DisallowQuantityMismatches
Price decimal? ...
Classification string
CountryOfManufacture string
HarmonizedCode string
InventoryCategory string
StorageRates IEnumerable<Customer.Models.ItemExchangeXactionCustomRate>
FacilityName string
UomName string
InventoryUnitsPerUnit decimal
StorageSplitFullRate decimal? ...
StorageSplitHalfRate decimal? ...
StorageFreeDays int? ...
RcvHandlingRate decimal? ...
OrdHandlingRate decimal? ...
LocationZones string
MovableUnitLocationZones string
OverAllocLocationZones string
PreferredLocationId int? ...
ForceIntoPreferredLocation bool? ...
AllowMixedItemStorage bool? ...
AllowMixedLotStorage bool? ...
MixedExpirationDaysThreshold int? ...
LabelingUnitUpc string
MovableUnitUpc string
SecondaryUnitUpc string
StorageChargeMin decimal? ...
StorageChargeMinMonthsToSkip int? ...
AutoHoldExpirationDaysThreshold int? ...
MaxToAllocateFromPickline decimal? ...
PicklineMin decimal? ...
PicklineMax decimal? ...
Replenishment bool
Links IList<WebApi.Hal.Link>
- /rels/customers/item
Sample content-type: application/hal+json
 
{
  "totalResults": 1,
  "_embedded": {
    "item": [
      {
        "sku": "str",
        "description": "str",
        "description2": "str",
        "min": 1.0,
        "max": 1.0,
        "cycleCount": 1,
        "reorderQty": 1.0,
        "inventoryMethod": "str",
        "temperature": 1.0,
        "cost": 1.0,
        "upc": "str",
        "isTrackLotNumber": true,
        "isTrackSerialNumber": true,
        "isTrackExpirationDate": true,
        "labelingUnitType": "str",
        "labelingUnitQty": 1.0,
        "labelingUnitLength": 1.0,
        "labelingUnitWidth": 1.0,
        "labelingUnitHeight": 1.0,
        "labelingUnitWeight": 1.0,
        "labelingUnitNetWeight": 1.0,
        "inventoryUnitOfMeasureType": "str",
        "secondaryUnitOfMeasureType": "str",
        "inventoryUnitsPerSecondUnit": 1.0,
        "nmfc": "str",
        "isTrackLotNumberRequired": true,
        "isTrackSerialNumberRequired": true,
        "isTrackSerialNumberUnique": true,
        "isTrackExpirationDateRequired": true,
        "isPickLotNumberRequired": true,
        "isPickSerialNumberRequired": true,
        "isPickExpirationDateRequired": true,
        "isTrackCost": true,
        "isTrackCostRequired": true,
        "movableUnitDescription": "str",
        "movableUnitTie": 1.0,
        "movableUnitHigh": 1.0,
        "movableUnitQty": 1.0,
        "movableUnitLength": 1.0,
        "movableUnitWidth": 1.0,
        "movableUnitHeight": 1.0,
        "movableUnitWeight": 1.0,
        "active": true,
        "storageUoms": [
          {
            "facilityName": "str",
            "uomName": "str",
            "inventoryUnitsPerUnit": 3.0
          }
        ],
        "renameSku": "str",
        "isHazMat": true,
        "hazMatId": "str",
        "hazMatShippingName": "str",
        "hazMatHazardClass": "str",
        "hazMatPackingGroup": "str",
        "hazMatFlashPoint": "str",
        "hazMatLabelCode": "str",
        "hazMatFlag": "str",
        "storageUnitOfMeasure": "str",
        "inventoryUnitsPerStorageUnit": 1.0,
        "storageCountScriptTemplateId": 1,
        "itemFacilityStorageRates": [
          {
            "facilityName": "str",
            "countUnitDescription": "str",
            "rate": 3.0
          }
        ],
        "outboundMobileSerializationBehavior": 0,
        "price": 1.0,
        "classification": "str",
        "countryOfManufacture": "str",
        "harmonizedCode": "str",
        "inventoryCategory": "str",
        "storageRates": [
          {
            "facilityName": "str",
            "uomName": "str",
            "inventoryUnitsPerUnit": 3.0,
            "storageSplitFullRate": 1.0,
            "storageSplitHalfRate": 1.0,
            "storageFreeDays": 1,
            "rcvHandlingRate": 1.0,
            "ordHandlingRate": 1.0
          }
        ],
        "locationZones": "str",
        "movableUnitLocationZones": "str",
        "overAllocLocationZones": "str",
        "preferredLocationId": 1,
        "forceIntoPreferredLocation": true,
        "allowMixedItemStorage": true,
        "allowMixedLotStorage": true,
        "mixedExpirationDaysThreshold": 1,
        "labelingUnitUpc": "str",
        "movableUnitUpc": "str",
        "secondaryUnitUpc": "str",
        "storageChargeMin": 1.0,
        "storageChargeMinMonthsToSkip": 1,
        "autoHoldExpirationDaysThreshold": 1,
        "maxToAllocateFromPickline": 1.0,
        "picklineMin": 1.0,
        "picklineMax": 1.0,
        "replenishment": true
      }
    ]
  }
}
Type Description
TotalResults int
ResourceList IList<Customer.Models.ItemExchange>
Sku string
Description string
Description2 string
Min decimal? ...
Max decimal? ...
CycleCount int? ...
ReorderQty decimal? ...
InventoryMethod string
Temperature decimal? ...
Cost decimal? ...
Upc string
IsTrackLotNumber bool? ...
IsTrackSerialNumber bool? ...
IsTrackExpirationDate bool? ...
LabelingUnitType string
LabelingUnitQty decimal? ...
LabelingUnitLength decimal? ...
LabelingUnitWidth decimal? ...
LabelingUnitHeight decimal? ...
LabelingUnitWeight decimal? ...
LabelingUnitNetWeight decimal? ...
InventoryUnitOfMeasureType string
SecondaryUnitOfMeasureType string
InventoryUnitsPerSecondUnit decimal? ...
Nmfc string
IsTrackLotNumberRequired bool? ...
IsTrackSerialNumberRequired bool? ...
IsTrackSerialNumberUnique bool? ...
IsTrackExpirationDateRequired bool? ...
IsPickLotNumberRequired bool
IsPickSerialNumberRequired bool
IsPickExpirationDateRequired bool
IsTrackCost bool? ...
IsTrackCostRequired bool? ...
MovableUnitDescription string
MovableUnitTie decimal? ...
MovableUnitHigh decimal? ...
MovableUnitQty decimal? ...
MovableUnitLength decimal? ...
MovableUnitWidth decimal? ...
MovableUnitHeight decimal? ...
MovableUnitWeight decimal? ...
Active bool? ...
StorageUoms IEnumerable<Customer.Models.ItemExchangeXactionStdRate>
FacilityName string
UomName string
InventoryUnitsPerUnit decimal
RenameSku string This value is only used on PUT: on input, it replaces Sku; on output it is null unless Sku was replaced in which case it is the original Sku value
IsHazMat bool? ...
HazMatId string
HazMatShippingName string
HazMatHazardClass string
HazMatPackingGroup string
HazMatFlashPoint string
HazMatLabelCode string
HazMatFlag string
StorageUnitOfMeasure string
InventoryUnitsPerStorageUnit decimal? ...
StorageCountScriptTemplateId int? ...
ItemFacilityStorageRates IEnumerable<Customer.Models.ItemExchangeStorageRate>
FacilityName string
CountUnitDescription string
Rate decimal
OutboundMobileSerializationBehavior Common.Enum.OutboundMobileSerializationBehavior? ...
- 0: Disabled
- 1: IgnoreQuantityMismatches
- 2: DisallowQuantityMismatches
Price decimal? ...
Classification string
CountryOfManufacture string
HarmonizedCode string
InventoryCategory string
StorageRates IEnumerable<Customer.Models.ItemExchangeXactionCustomRate>
FacilityName string
UomName string
InventoryUnitsPerUnit decimal
StorageSplitFullRate decimal? ...
StorageSplitHalfRate decimal? ...
StorageFreeDays int? ...
RcvHandlingRate decimal? ...
OrdHandlingRate decimal? ...
LocationZones string
MovableUnitLocationZones string
OverAllocLocationZones string
PreferredLocationId int? ...
ForceIntoPreferredLocation bool? ...
AllowMixedItemStorage bool? ...
AllowMixedLotStorage bool? ...
MixedExpirationDaysThreshold int? ...
LabelingUnitUpc string
MovableUnitUpc string
SecondaryUnitUpc string
StorageChargeMin decimal? ...
StorageChargeMinMonthsToSkip int? ...
AutoHoldExpirationDaysThreshold int? ...
MaxToAllocateFromPickline decimal? ...
PicklineMin decimal? ...
PicklineMax decimal? ...
Replenishment bool
Links IList<WebApi.Hal.Link>
- /rels/customers/item
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "item": [
      {
        "sku": "str",
        "description": "str",
        "description2": "str",
        "min": 1.0,
        "max": 1.0,
        "cycleCount": 1,
        "reorderQty": 1.0,
        "inventoryMethod": "str",
        "temperature": 1.0,
        "cost": 1.0,
        "upc": "str",
        "isTrackLotNumber": true,
        "isTrackSerialNumber": true,
        "isTrackExpirationDate": true,
        "labelingUnitType": "str",
        "labelingUnitQty": 1.0,
        "labelingUnitLength": 1.0,
        "labelingUnitWidth": 1.0,
        "labelingUnitHeight": 1.0,
        "labelingUnitWeight": 1.0,
        "labelingUnitNetWeight": 1.0,
        "inventoryUnitOfMeasureType": "str",
        "secondaryUnitOfMeasureType": "str",
        "inventoryUnitsPerSecondUnit": 1.0,
        "nmfc": "str",
        "isTrackLotNumberRequired": true,
        "isTrackSerialNumberRequired": true,
        "isTrackSerialNumberUnique": true,
        "isTrackExpirationDateRequired": true,
        "isPickLotNumberRequired": true,
        "isPickSerialNumberRequired": true,
        "isPickExpirationDateRequired": true,
        "isTrackCost": true,
        "isTrackCostRequired": true,
        "movableUnitDescription": "str",
        "movableUnitTie": 1.0,
        "movableUnitHigh": 1.0,
        "movableUnitQty": 1.0,
        "movableUnitLength": 1.0,
        "movableUnitWidth": 1.0,
        "movableUnitHeight": 1.0,
        "movableUnitWeight": 1.0,
        "active": true,
        "storageUoms": [
          {
            "facilityName": "str",
            "uomName": "str",
            "inventoryUnitsPerUnit": 3.0
          }
        ],
        "renameSku": "str",
        "isHazMat": true,
        "hazMatId": "str",
        "hazMatShippingName": "str",
        "hazMatHazardClass": "str",
        "hazMatPackingGroup": "str",
        "hazMatFlashPoint": "str",
        "hazMatLabelCode": "str",
        "hazMatFlag": "str",
        "storageUnitOfMeasure": "str",
        "inventoryUnitsPerStorageUnit": 1.0,
        "storageCountScriptTemplateId": 1,
        "itemFacilityStorageRates": [
          {
            "facilityName": "str",
            "countUnitDescription": "str",
            "rate": 3.0
          }
        ],
        "outboundMobileSerializationBehavior": 0,
        "price": 1.0,
        "classification": "str",
        "countryOfManufacture": "str",
        "harmonizedCode": "str",
        "inventoryCategory": "str",
        "storageRates": [
          {
            "facilityName": "str",
            "uomName": "str",
            "inventoryUnitsPerUnit": 3.0,
            "storageSplitFullRate": 1.0,
            "storageSplitHalfRate": 1.0,
            "storageFreeDays": 1,
            "rcvHandlingRate": 1.0,
            "ordHandlingRate": 1.0
          }
        ],
        "locationZones": "str",
        "movableUnitLocationZones": "str",
        "overAllocLocationZones": "str",
        "preferredLocationId": 1,
        "forceIntoPreferredLocation": true,
        "allowMixedItemStorage": true,
        "allowMixedLotStorage": true,
        "mixedExpirationDaysThreshold": 1,
        "labelingUnitUpc": "str",
        "movableUnitUpc": "str",
        "secondaryUnitUpc": "str",
        "storageChargeMin": 1.0,
        "storageChargeMinMonthsToSkip": 1,
        "autoHoldExpirationDaysThreshold": 1,
        "maxToAllocateFromPickline": 1.0,
        "picklineMin": 1.0,
        "picklineMax": 1.0,
        "replenishment": true
      }
    ]
  }
}

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.