REL documentation
Resource:Operator: parse order import fileC# Rel Const:Rels.OrderSvc.FileParseURI template:fileparser{?customerId,facilityId,transformId,checkInventory,fileName}Obtain URI from:
Parse contents of import file.
Use content-type: text/plain, with the request body being the contents of the file.
Exceptions: general System.Exception if parse failed, or ListException containing validation errors of individual orders.
Success status: 200
| Name (* = required) | Data Type | Description |
|---|---|---|
| customerId * | int | orders will be for this customer |
| facilityId * | int | facility from which to pull inventory |
| transformId | int | identifies which parser to use; if unspecified will be determined from customer setup and file content |
| checkInventory | bool | true: check inventory to determine if order can be fully allocated |
| fileName | string |
this object model should not be used directly by the API client, but is assembled by the media formatter from the request's content-type and payload
| Type | Description | |
|---|---|---|
| ContentType | string | obtained from the HTTP "Content-Type" header |
| Content | Object | obtained from the HTTP payload |
Sample content-type: application/hal+json |
{
"contentType": "str",
"content": {}
}
the results of parsing an import file into individual OrderCreate objects ready to POST to /orders or /orders/importer
Array of OrderCreate objects ready to POST one at a time or all at once.
| Type | Description | |
|---|---|---|
| TransformId | int | |
| FileFormat | Common.Enum.InputParserFormatType | |
| - 0: EDI | ||
| - 1: TabDelim | ||
| - 2: XML | ||
| - 3: Unknown | ||
| Orders | IEnumerable<Order.Models.ImportFileParseOrder> | |
| Order | Order.Models.OrderCreate | object model created from one entry of an import file |
| CustomerIdentifier | Generic.Models.CustomerIdentifier | |
| ExternalId | string | |
| Name | string | |
| Id | int | |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| WarehouseTransactionSourceEnum | Common.Enum.WarehouseTransactionSourceType | how the transaction entered the system |
| - 0: Unknown | ||
| - 1: UiManual | ||
| - 2: UiImport | ||
| - 3: AutomatedImport | ||
| - 4: ExternalSoapApi | ||
| - 5: QuickBooksSoapApi | ||
| - 6: AutomatedSystemCharge | ||
| - 7: RestApi | ||
| TransactionEntryTypeEnum | Common.Enum.TransactionEntryType | the agent creating the transaction |
| - 0: DoangHair | unknown | |
| - 1: ManualWarehouseUser | ||
| - 2: ManualCustomerUser | ||
| - 3: Ftp | ||
| - 4: Api | ||
| ImportChannelIdentifier | Generic.Models.ChannelIdentifier | reference to the channel through which this order was imported; must specify Id (Name alone will fail) |
| Name | string | |
| Id | int | |
| ImportModuleId | int? ... | |
| ExportModuleIds | string | |
| DeferNotification | bool? ... | An OrderCreate notification is sent when a new order enters the "complete" state. True means the order will be created in an "incomplete" state; False means the order will be created in a "complete" state; If not specified, the order will be created in an "incomplete" state if OrderQueue is on and in a "complete" state if OrderQueue is off. Note: OrderQueue is relevant because an order's "complete"-ness also affects when allocation occurs. |
| OrderItems | IList<Order.Models.OrderItem> | |
| ReadOnly | Order.Models.OrderItemReadOnly | |
| OrderItemId | int | |
| FullyAllocated | bool | |
| UnitIdentifier | Generic.Models.UnitOfMeasureIdentifier | for convenience, referenced item's primary inventory unit |
| Name | string | |
| Id | int | |
| SecondaryUnitIdentifier | Generic.Models.UnitOfMeasureIdentifier | for convenience, referenced item's secondary inventory unit if defined |
| Name | string | |
| Id | int | |
| EstimatedQty | decimal? ... | if present, calculated from SecondaryQty and cannot confirm until Qty entered |
| EstimatedSecondaryQty | decimal? ... | if present, calculated from Qty and cannot confirm until SecondaryQty entered |
| OriginalPrimaryQty | decimal? ... | on a shorted order, specifies original quantity ordered; otherwise same as Qty |
| IsOrderQtySecondary | bool | if both Qty and SecondaryQty present, indicates whether at some point prior to shipping only SecondaryQty was present |
| Allocations | IEnumerable<Order.Models.Allocation> | supplied on GET {get;set;} ignored on PUT, POST |
| ReceiveItemId | int | |
| Qty | decimal | |
| ProperlyPickedPrimary | decimal | |
| ProperlyPickedSecondary | decimal | |
| LoadedOut | bool | |
| Detail | Order.Models.AllocationDetail | null unless requested by including AllocationsWithDetail in OrderItemChildren |
| ItemTraits | Generic.Models.ItemTraits | unique identifying characteristics of an item in a location |
| ItemIdentifier | Generic.Models.ItemIdentifier | |
| Sku | string | |
| Id | int | |
| Qualifier | string | |
| LotNumber | string | |
| SerialNumber | string | |
| Cost | decimal? ... | |
| ExpirationDate | DateTime? ... | |
| PalletIdentifier | Generic.Models.PalletIdentifier | |
| NameKey | Generic.Models.PalletNameKey | |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| Name | string | |
| Id | int | |
| LocationIdentifier | Generic.Models.LocationIdentifier | |
| NameKey | Generic.Models.LocationNameKey | |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| Name | string | |
| Id | int | |
| LocationSort | Order.Models.LocationSort | |
| Field1 | string | |
| Field2 | string | |
| Field3 | string | |
| Field4 | string | |
| SavedElements | IEnumerable<Generic.Models.SavedElement> | |
| Name | string | |
| Value | string | |
| PickPath | int? ... | |
| Bin | string | supplied on GET, ignored on PUT, POST; use pick operations to set; cleared when shipped or packaged |
| IsInsert | bool | |
| MaxToAllocateFromPickLine | decimal? ... | Represents the max amount of an item that will be allocated from a pickline location for replenishment |
| ItemIdentifier | Generic.Models.ItemIdentifier | |
| Sku | string | |
| Id | int | |
| Qualifier | string | |
| ExternalId | string | connection of this order item to the same order item on some other system |
| Qty | decimal? ... | primary inventory quantity ordered; if not specified, must specify SecondaryQty more... |
| SecondaryQty | decimal? ... | optional secondary quantity ordered; if not specified, must specify Qty more... |
| LotNumber | string | if present, used to allocate matching inventory |
| SerialNumber | string | if present, used to allocate matching inventory |
| ExpirationDate | DateTime? ... | if present, used to allocate matching inventory |
| WeightImperial | decimal? ... | ship weight of order item, imperial; if specified and metric not specified, business logic computes metric more... |
| WeightMetric | decimal? ... | ship weight of order item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation |
| Notes | string | |
| FulfillInvSalePrice | decimal? ... | |
| FulfillInvDiscountPct | decimal? ... | |
| FulfillInvDiscountAmt | decimal? ... | |
| FulfillInvNote | string | |
| SavedElements | IEnumerable<Generic.Models.SavedElement> | |
| Name | string | |
| Value | string | |
| ProposedAllocations | IEnumerable<Generic.Models.ProposedAllocation> | empty on GET; may be supplied on PUT, POST |
| Generic.Models.ProposedAllocation | A manual allocation. | |
| ReceiveItemId | int | |
| Qty | decimal | |
| OrderItemInPackages | IEnumerable<Order.Models.OrderItemInPackage> | declares the package arrangement, which gets translated into real packages, during order creation; empty on GET; ignored on PUT; may be supplied on POST |
| PackageNumber | int | use the same number on multiple OrderItemInPackages to add package content to the same package |
| Quantity | decimal | how much of the orderitem to pack into this package content; must be a positive number |
| PackageDefIdentifier | Generic.Models.PackageDefIdentifier | the package definition to apply to any package created as a result of this OrderItemInPackage |
| Name | string | |
| Id | int | |
| IsInsert | bool | |
| Links | IList<WebApi.Hal.Link> | |
| - edit | ||
| - /rels/customers/item | The ordered item. | |
| - /rels/customers/itemsummary | The ordered item summary, sufficient for editing order item. | |
| - /rels/orders/order | The containing order. | |
| - /rels/orders/itemallocate | Operator to allocate this item. | |
| - /rels/orders/itemdeallocate | Operator to deallocate this item. | |
| ReferenceNum | string | |
| Description | string | |
| PoNum | string | |
| ExternalId | string | connection of this order to the same order on some other system |
| EarliestShipDate | DateTime? ... | |
| ShipCancelDate | DateTime? ... | |
| Notes | string | |
| NumUnits1 | decimal? ... | |
| Unit1Identifier | Generic.Models.UnitOfMeasureIdentifier | |
| Name | string | |
| Id | int | |
| NumUnits2 | decimal? ... | |
| Unit2Identifier | Generic.Models.UnitOfMeasureIdentifier | |
| Name | string | |
| Id | int | |
| TotalWeight | decimal? ... | |
| TotalVolume | decimal? ... | |
| BillingCode | string | |
| AsnNumber | string | |
| UpsServiceOptionCharge | decimal? ... | |
| UpsTransportationCharge | decimal? ... | |
| AddFreightToCod | bool | |
| UpsIsResidential | bool | |
| ExportChannelIdentifier | Generic.Models.ChannelIdentifier | A reference to the channel used to export an Advance Shipping Notice or RoutingRequest; must specify Id (Name alone will fail) |
| Name | string | |
| Id | int | |
| RoutePickupDate | DateTime? ... | |
| ShippingNotes | string | |
| MasterBillOfLadingId | string | |
| InvoiceNumber | string | |
| FulfillInvInfo | Order.Models.FulfillInvInfo | |
| FulfillInvShippingAndHandling | decimal? ... | |
| FulfillInvTax | decimal? ... | |
| FulfillInvDiscountCode | string | |
| FulfillInvDiscountAmount | decimal? ... | |
| RoutingInfo | Order.Models.RoutingInfo | |
| IsCod | bool | |
| IsInsurance | bool | |
| RequiresDeliveryConf | bool | |
| RequiresReturnReceipt | bool | |
| ScacCode | string | |
| Carrier | string | |
| Mode | string | |
| Account | string | |
| ShipPointZip | string | |
| CapacityTypeIdentifier | Generic.Models.CapacityTypeIdentifier | |
| Name | string | |
| Id | int | |
| LoadNumber | string | |
| BillOfLading | string | |
| TrackingNumber | string | |
| TrailerNumber | string | |
| SealNumber | string | |
| DoorNumber | string | |
| PickupDate | DateTime? ... | |
| Billing | Generic.Models.Billing | PUT: set to null to make no changes to billing |
| BillingCharges | ICollection<Generic.Models.BillingCharge> | PUT: set to NULL or empty to delete all charges |
| ChargeType | Common.Enum.PriceCalcFieldType | charge type |
| - 1: Handling | ||
| - 2: Storage | ||
| - 3: PrepaidFreight | ||
| - 4: ThirdPartyFreight | ||
| - 5: SpecialCharges | ||
| - 6: Materials | ||
| - 7: AutoCalcStorage | used internally for sys-gen'ed charges | |
| - 8: AutoCalcHandling | used internally for sys-gen'ed charges | |
| - 8: MAXVAL | ignore, not a real value | |
| Subtotal | decimal | |
| Details | ICollection<Generic.Models.BillingChargeDetail> | |
| WarehouseTransactionPriceCalcId | int | |
| NumUnits | decimal | |
| ChargeLabel | string | |
| UnitDescription | string | |
| ChargePerUnit | decimal | |
| GlAcctNum | string | |
| Sku | string | |
| PtItem | string | |
| PtItemDescription | string | |
| PtArAcct | string | |
| SystemGenerated | bool | |
| TaxCode | string | Empty on GET. If present on POST or PUT, may create or update a "matching" PriceCalcRate record to be used while generating invoices |
| RecurringChargeDetails | IEnumerable<Generic.Models.RecurringChargeDetail> | On GET of charge Adjustments only |
| RecurringBillingDetailId | int | |
| ReceiveItemId | int | |
| OnHandAtBillTime | decimal | |
| ItemIdentifier | Generic.Models.ItemIdentifier | |
| Sku | string | |
| Id | int | |
| Qualifier | string | |
| LotNumber | string | |
| SerialNumber | string | |
| ExpirationDate | DateTime? ... | |
| Cost | decimal? ... | |
| SupplierIdentifier | Generic.Models.ContactIdentifier | |
| Name | string | |
| Id | int | |
| LocationIdentifier | Generic.Models.LocationIdentifier | |
| NameKey | Generic.Models.LocationNameKey | |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| Name | string | |
| Id | int | |
| PalletIdentifier | Generic.Models.PalletIdentifier | |
| NameKey | Generic.Models.PalletNameKey | |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| Name | string | |
| Id | int | |
| ShipTo | Generic.Models.OrderShipToInfo | if not found, creates new shipto contact |
| RetailerInfo | Generic.Models.RetailerInfo | in GETs: the retailer; in POSTs or PUTs: identifies existing retailer or properties of new retailer |
| NameKey | Generic.Models.RetailerNameKey | |
| CustomerIdentifier | Generic.Models.CustomerIdentifier | |
| ExternalId | string | |
| Name | string | |
| Id | int | |
| Name | string | |
| Number | string | |
| Id | int | |
| SameAs | Common.Enum.ContactType? ... | PUT or POST: to use same Contact as another contact on the same order; GET: always null more... |
| - 0: ShipTo | ||
| - 1: SoldTo | ||
| - 2: BillTo | ||
| RetailerId | int? ... | DEPRECATED, will be removed from model: for ShipTo, use RetailerInfo; for SoldTo and BillTo, ignored |
| IsQuickLookup | bool | |
| ContactId | int? ... | for identifying: if known specify only this; other fields are ignored |
| CompanyName | string | |
| Name | string | |
| Title | string | |
| Address1 | string | |
| Address2 | string | |
| City | string | |
| State | string | |
| Zip | string | |
| Country | string | |
| PhoneNumber | string | |
| Fax | string | |
| EmailAddress | string | |
| Dept | string | |
| IsAddressResidential | bool | |
| Code | string | for identifying: if known specify only this; if other fields also specified it is not used to identify |
| AddressStatus | Common.Enum.AddressStatusType | confirmation status |
| - 0: Unconfirmed | ||
| - 1: Confirmed | ||
| - 2: UserAccepted | ||
| SoldTo | Generic.Models.OrderContactInfo | if not found, creates new soldto contact more... |
| Generic.Models.OrderContactInfo | in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact more... | |
| SameAs | Common.Enum.ContactType? ... | PUT or POST: to use same Contact as another contact on the same order; GET: always null more... |
| - 0: ShipTo | ||
| - 1: SoldTo | ||
| - 2: BillTo | ||
| RetailerId | int? ... | DEPRECATED, will be removed from model: for ShipTo, use RetailerInfo; for SoldTo and BillTo, ignored |
| IsQuickLookup | bool | |
| ContactId | int? ... | for identifying: if known specify only this; other fields are ignored |
| CompanyName | string | |
| Name | string | |
| Title | string | |
| Address1 | string | |
| Address2 | string | |
| City | string | |
| State | string | |
| Zip | string | |
| Country | string | |
| PhoneNumber | string | |
| Fax | string | |
| EmailAddress | string | |
| Dept | string | |
| IsAddressResidential | bool | |
| Code | string | for identifying: if known specify only this; if other fields also specified it is not used to identify |
| AddressStatus | Common.Enum.AddressStatusType | confirmation status |
| - 0: Unconfirmed | ||
| - 1: Confirmed | ||
| - 2: UserAccepted | ||
| BillTo | Generic.Models.OrderContactInfo | if not found, creates new billto contact more... |
| Generic.Models.OrderContactInfo | in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact more... | |
| SameAs | Common.Enum.ContactType? ... | PUT or POST: to use same Contact as another contact on the same order; GET: always null more... |
| - 0: ShipTo | ||
| - 1: SoldTo | ||
| - 2: BillTo | ||
| RetailerId | int? ... | DEPRECATED, will be removed from model: for ShipTo, use RetailerInfo; for SoldTo and BillTo, ignored |
| IsQuickLookup | bool | |
| ContactId | int? ... | for identifying: if known specify only this; other fields are ignored |
| CompanyName | string | |
| Name | string | |
| Title | string | |
| Address1 | string | |
| Address2 | string | |
| City | string | |
| State | string | |
| Zip | string | |
| Country | string | |
| PhoneNumber | string | |
| Fax | string | |
| EmailAddress | string | |
| Dept | string | |
| IsAddressResidential | bool | |
| Code | string | for identifying: if known specify only this; if other fields also specified it is not used to identify |
| AddressStatus | Common.Enum.AddressStatusType | confirmation status |
| - 0: Unconfirmed | ||
| - 1: Confirmed | ||
| - 2: UserAccepted | ||
| SavedElements | IEnumerable<Generic.Models.SavedElement> | |
| Name | string | |
| Value | string | |
| ParcelOption | Order.Models.ParcelOption | |
| OrderId | int | |
| DeliveryConfirmationType | string | |
| DeliveredDutyPaid | int | |
| DryIceWeight | decimal | |
| InsuranceAmount | decimal | |
| InsuranceType | int | |
| InternationalContentsType | string | |
| InternationalNonDelivery | string | |
| ResidentialFlag | bool | |
| SaturdayDeliveryFlag | bool | |
| TaxIdentifiers | string | |
| CarrierAccountNumber | string | |
| CarrierSelectionV2 | bool | |
| ShipDate | string | |
| ChosenRate | string | |
| Inserts | IEnumerable<Order.Models.OrderInsert> | a set of so-called non-sku items inerted or to be inserted into the order packages |
| PackageInsertIdentifier | Generic.Models.PackageInsertIdentifier | |
| Name | string | |
| Id | int | |
| Quantity | decimal | |
| InsertedQuantity | decimal? ... | |
| Barcode | string | |
| FullyAllocated | bool? ... | populated only if "checkInventory" requested, in which case: true=can be fully allocated; false=insufficient inventory; null=failed during attempt to check |
| ItemsToCreate | IEnumerable<Customer.Models.Item> | |
| ReadOnly | Customer.Models.ItemReadOnly | |
| CustomerIdentifier | Generic.Models.CustomerIdentifier | |
| ExternalId | string | |
| Name | string | |
| Id | int | |
| ItemId | int | |
| CreationDate | DateTime? ... | |
| LastModifiedDate | DateTime? ... | |
| Deactivated | bool | |
| LastPriceChange | DateTime? ... | |
| HasStorageRates | bool | |
| ItemId | int | |
| Sku | string | |
| Upc | string | |
| Description | string | |
| Description2 | string | |
| InventoryCategory | string | |
| ClassificationIdentifier | Generic.Models.ItemClassificationIdentifier | |
| Name | string | |
| Id | int | |
| Nmfc | string | |
| Cost | decimal? ... | |
| Price | decimal? ... | |
| Temperature | decimal? ... | |
| MaxAllocateFromPickline | decimal? ... | |
| PicklineMin | decimal? ... | |
| PicklineMax | decimal? ... | |
| AccountRef | string | |
| CountryOfManufacture | string | |
| HarmonizedCode | string | |
| Qualifiers | IList<Customer.Models.ItemQualifier> | |
| Qualifier | string | |
| Links | IList<WebApi.Hal.Link> | |
| - /rels/inventory/stocksummaries | ||
| QualifierRenamers | IEnumerable<Customer.Models.QualifierRenamer> | |
| Qualifier | string | |
| Renames | string | |
| Kit | Customer.Models.Kit | to determine whether an item is a kit/assembly, use 'rql=kit.materialnotes=hv=true' |
| MaterialNotes | string | |
| Components | IEnumerable<Customer.Models.Component> | |
| ItemIdentifier | Generic.Models.ItemIdentifier | |
| Sku | string | |
| Id | int | |
| Qualifier | string | |
| Qty | decimal? ... | |
| NonSkuMaterial | string | |
| Options | Customer.Models.ItemOptions | |
| InventoryUnit | Customer.Models.InventoryUnit | |
| UnitIdentifier | Generic.Models.UnitOfMeasureIdentifier | |
| Name | string | |
| Id | int | |
| MinimumStock | decimal? ... | |
| MaximumStock | decimal? ... | |
| ReorderQuantity | decimal? ... | |
| InventoryMethod | Common.Enum.InventoryMethodEnum | |
| - 1: FIFO | ||
| - 2: LIFO | ||
| - 3: FEFO | ||
| SecondaryUnit | Customer.Models.SecondaryUnit | |
| InventoryAlso | bool | |
| Upc | string | |
| UnitIdentifier | Generic.Models.UnitOfMeasureIdentifier | |
| Name | string | |
| Id | int | |
| InventoryUnitsPerUnit | decimal | |
| PackageUnit | Customer.Models.PackageUnit | |
| Imperial | Customer.Models.DimensionNet | |
| NetWeight | decimal? ... | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| Metric | Customer.Models.DimensionNet | |
| NetWeight | decimal? ... | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| Upc | string | |
| UnitIdentifier | Generic.Models.UnitOfMeasureIdentifier | |
| Name | string | |
| Id | int | |
| InventoryUnitsPerUnit | decimal | |
| TrackBys | Customer.Models.TrackBys | |
| TrackLotNumber | Common.Enum.UsageLevel | |
| - 0: Disallow | ||
| - 1: Allow | ||
| - 2: Require | ||
| TrackSerialNumber | Common.Enum.SerialNumberUsageLevel | |
| - 0: Disallow | ||
| - 1: Allow | ||
| - 2: AllowUnique | ||
| - 3: Require | ||
| - 4: RequireUnique | ||
| TrackExpirationDate | Common.Enum.UsageLevel | |
| - 0: Disallow | ||
| - 1: Allow | ||
| - 2: Require | ||
| TrackCost | Common.Enum.UsageLevel | |
| - 0: Disallow | ||
| - 1: Allow | ||
| - 2: Require | ||
| OutboundMobileSerialization | Common.Enum.OutboundMobileSerializationBehavior | |
| - 0: Disabled | ||
| - 1: IgnoreQuantityMismatches | ||
| - 2: DisallowQuantityMismatches | ||
| AutoHoldExpirationDaysThreshold | int? ... | |
| IsPickLotNumberRequired | bool | |
| IsPickSerialNumberRequired | bool | |
| IsPickExpirationDateRequired | bool | |
| Pallets | Customer.Models.Pallets | |
| TypeIdentifier | Generic.Models.PalletTypeIdentifier | |
| Name | string | |
| Id | int | |
| Tie | decimal? ... | |
| High | decimal? ... | |
| Qty | decimal? ... | the number of primary units of this item on a typical pallet |
| Imperial | Generic.Models.Dimension | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| Metric | Generic.Models.Dimension | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| Upc | string | |
| HazMat | Customer.Models.HazMat | |
| IsHazMat | bool | |
| Id | string | |
| ShippingName | string | |
| HazardClass | string | |
| PackingGroup | string | |
| FlashPoint | string | |
| LabelCode | string | |
| Flag | string | |
| DirectedPutAway | Customer.Models.DirectedPutAway | |
| LocationZones | string | |
| PalletLocationZones | string | |
| OverAllocLocationZones | string | |
| PreferredLocationIdentifier | Generic.Models.LocationIdentifier | |
| NameKey | Generic.Models.LocationNameKey | |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| Name | string | |
| Id | int | |
| ForceIntoPreferredLocation | bool | |
| AllowMixedItemStorage | bool | |
| AllowMixedLotStorage | bool | |
| MixedExpirationDaysThreshold | int? ... | |
| DaysBetweenCounts | int? ... | |
| AutoHoldOnReceive | bool | |
| Replenishment | bool | |
| Links | IList<WebApi.Hal.Link> | |
| - edit | ||
| - /rels/customers/itemactivate | ||
| - /rels/customers/customer | ||
| - /rels/customers/itemrates | ||
| - /rels/customers/itemimage | ||
| ListException | Generic.Models.Exceptions.ListException | container of WmsExceptionBase-derived exceptions occuring during actions on lists, such as import or mass ops |
| Faults | IList<Generic.Models.Exceptions.ListEntryFault> | |
| EntryNumber | int | 1-indexed position in the source list |
| EntryInfo | string | optional info about the entry in the source list, such as id, sku, ref#, etc. |
| WmsException | Generic.Models.Exceptions.WmsExceptionBase | for more details at runtime see which WmsExceptionBase-derived exception it is |
| ErrorCode | string | could have been a number, but is a short string for human readability; not to be localized |
| Hint | string | helpful word or two if the thrower happens to know more things; not to be localized |
| InnerException | System.Exception | |
| Links | IList<WebApi.Hal.Link> | |
| - /rels/orders/import | create orders |
Sample accept: application/hal+json
{
"transformId": 1,
"fileFormat": 0,
"orders": [
{
"order": {
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"facilityIdentifier": {
"name": "str",
"id": 2
},
"warehouseTransactionSourceEnum": 0,
"transactionEntryTypeEnum": 0,
"importChannelIdentifier": {
"name": "str",
"id": 2
},
"importModuleId": 1,
"exportModuleIds": "str",
"deferNotification": true,
"orderItems": [
{
"readOnly": {
"orderItemId": 1,
"fullyAllocated": true,
"unitIdentifier": {
"name": "str",
"id": 2
},
"secondaryUnitIdentifier": {
"name": "str",
"id": 2
},
"estimatedQty": 1.0,
"estimatedSecondaryQty": 1.0,
"originalPrimaryQty": 1.0,
"isOrderQtySecondary": true,
"allocations": [
{
"receiveItemId": 1,
"qty": 2.0,
"properlyPickedPrimary": 3.0,
"properlyPickedSecondary": 4.0,
"loadedOut": true,
"rowVersion": "str",
"detail": {
"itemTraits": {
"itemIdentifier": {
"sku": "str",
"id": 2
},
"qualifier": "str",
"lotNumber": "str",
"serialNumber": "str",
"cost": 1.0,
"expirationDate": "2016-12-25T23:00:00",
"palletIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
}
},
"locationIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
},
"locationSort": {
"field1": "str",
"field2": "str",
"field3": "str",
"field4": "str"
},
"savedElements": [
{
"name": "str",
"value": "str"
}
],
"pickPath": 1
}
}
],
"bin": "str",
"isInsert": true,
"maxToAllocateFromPickLine": 1.0,
"rowVersion": "str"
},
"itemIdentifier": {
"sku": "str",
"id": 2
},
"qualifier": "str",
"externalId": "str",
"qty": 1.0,
"secondaryQty": 1.0,
"lotNumber": "str",
"serialNumber": "str",
"expirationDate": "2016-12-25T23:00:00",
"weightImperial": 1.0,
"weightMetric": 1.0,
"notes": "str",
"fulfillInvSalePrice": 1.0,
"fulfillInvDiscountPct": 1.0,
"fulfillInvDiscountAmt": 1.0,
"fulfillInvNote": "str",
"savedElements": [
{
"name": "str",
"value": "str"
}
],
"proposedAllocations": [
{
"receiveItemId": 1,
"qty": 2.0
}
],
"orderItemInPackages": [
{
"packageNumber": 1,
"quantity": 2.0,
"packageDefIdentifier": {
"name": "str",
"id": 2
}
}
],
"isInsert": true,
"_links": null
}
],
"referenceNum": "str",
"description": "str",
"poNum": "str",
"externalId": "str",
"earliestShipDate": "2016-12-25T23:00:00",
"shipCancelDate": "2016-12-25T23:00:00",
"notes": "str",
"numUnits1": 1.0,
"unit1Identifier": {
"name": "str",
"id": 2
},
"numUnits2": 1.0,
"unit2Identifier": {
"name": "str",
"id": 2
},
"totalWeight": 1.0,
"totalVolume": 1.0,
"billingCode": "str",
"asnNumber": "str",
"upsServiceOptionCharge": 1.0,
"upsTransportationCharge": 1.0,
"addFreightToCod": true,
"upsIsResidential": true,
"exportChannelIdentifier": {
"name": "str",
"id": 2
},
"routePickupDate": "2016-12-25T23:00:00",
"shippingNotes": "str",
"masterBillOfLadingId": "str",
"invoiceNumber": "str",
"fulfillInvInfo": {
"fulfillInvShippingAndHandling": 1.0,
"fulfillInvTax": 1.0,
"fulfillInvDiscountCode": "str",
"fulfillInvDiscountAmount": 1.0,
"fulfillInvGiftMessage": "str"
},
"routingInfo": {
"isCod": true,
"isInsurance": true,
"requiresDeliveryConf": true,
"requiresReturnReceipt": true,
"scacCode": "str",
"carrier": "str",
"mode": "str",
"account": "str",
"shipPointZip": "str",
"capacityTypeIdentifier": {
"name": "str",
"id": 2
},
"loadNumber": "str",
"billOfLading": "str",
"trackingNumber": "str",
"trailerNumber": "str",
"sealNumber": "str",
"doorNumber": "str",
"pickupDate": "2016-12-25T23:00:00"
},
"billing": {
"billingCharges": [
{
"chargeType": 1,
"subtotal": 1.0,
"details": [
{
"warehouseTransactionPriceCalcId": 1,
"numUnits": 2.0,
"chargeLabel": "str",
"unitDescription": "str",
"chargePerUnit": 5.0,
"glAcctNum": "str",
"sku": "str",
"ptItem": "str",
"ptItemDescription": "str",
"ptArAcct": "str",
"systemGenerated": true,
"taxCode": "str",
"recurringChargeDetails": [
{
"recurringBillingDetailId": 1,
"receiveItemId": 2,
"onHandAtBillTime": 3.0,
"itemIdentifier": {
"sku": "str",
"id": 2
},
"qualifier": "str",
"lotNumber": "str",
"serialNumber": "str",
"expirationDate": "2016-12-25T23:00:00",
"cost": 1.0,
"supplierIdentifier": {
"name": "str",
"id": 2
},
"locationIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
},
"palletIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
}
}
]
}
]
}
]
},
"shipTo": {
"retailerInfo": {
"nameKey": {
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"name": "str",
"number": "str"
},
"id": 1
},
"sameAs": 0,
"retailerId": 1,
"isQuickLookup": true,
"contactId": 1,
"companyName": "str",
"name": "str",
"title": "str",
"address1": "str",
"address2": "str",
"city": "str",
"state": "str",
"zip": "str",
"country": "str",
"phoneNumber": "str",
"fax": "str",
"emailAddress": "str",
"dept": "str",
"isAddressResidential": true,
"code": "str",
"addressStatus": 0
},
"soldTo": {
"sameAs": 0,
"retailerId": 1,
"isQuickLookup": true,
"contactId": 1,
"companyName": "str",
"name": "str",
"title": "str",
"address1": "str",
"address2": "str",
"city": "str",
"state": "str",
"zip": "str",
"country": "str",
"phoneNumber": "str",
"fax": "str",
"emailAddress": "str",
"dept": "str",
"isAddressResidential": true,
"code": "str",
"addressStatus": 0
},
"billTo": {
"sameAs": 0,
"retailerId": 1,
"isQuickLookup": true,
"contactId": 1,
"companyName": "str",
"name": "str",
"title": "str",
"address1": "str",
"address2": "str",
"city": "str",
"state": "str",
"zip": "str",
"country": "str",
"phoneNumber": "str",
"fax": "str",
"emailAddress": "str",
"dept": "str",
"isAddressResidential": true,
"code": "str",
"addressStatus": 0
},
"savedElements": [
{
"name": "str",
"value": "str"
}
],
"parcelOption": {
"orderId": 1,
"deliveryConfirmationType": "str",
"deliveredDutyPaid": 3,
"dryIceWeight": 4.0,
"insuranceAmount": 5.0,
"insuranceType": 6,
"internationalContentsType": "str",
"internationalNonDelivery": "str",
"residentialFlag": true,
"saturdayDeliveryFlag": true,
"taxIdentifiers": "str",
"carrierAccountNumber": "str",
"carrierSelectionV2": true,
"shipDate": "str",
"chosenRate": "str"
},
"inserts": [
{
"packageInsertIdentifier": {
"name": "str",
"id": 2
},
"quantity": 1.0,
"insertedQuantity": 1.0,
"barcode": "str"
}
],
"_links": null
},
"fullyAllocated": true
}
],
"listException": {
"message": "ListException: Faults [{EntryNumber 1, }]",
"faults": [
{
"entryNumber": 1,
"entryInfo": "str"
}
],
"data": {},
"helpLink": "str",
"source": "str",
"hResult": 3
},
"_embedded": {
"http://api.3plCentral.com/rels/customers/item": [
{
"readOnly": {
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"itemId": 1,
"creationDate": "2016-12-25T23:00:00",
"lastModifiedDate": "2016-12-25T23:00:00",
"deactivated": true,
"lastPriceChange": "2016-12-25T23:00:00",
"hasStorageRates": true,
"rowVersion": "str"
},
"itemId": 1,
"sku": "str",
"upc": "str",
"description": "str",
"description2": "str",
"inventoryCategory": "str",
"classificationIdentifier": {
"name": "str",
"id": 2
},
"nmfc": "str",
"cost": 1.0,
"price": 1.0,
"temperature": 1.0,
"maxAllocateFromPickline": 1.0,
"picklineMin": 1.0,
"picklineMax": 1.0,
"accountRef": "str",
"countryOfManufacture": "str",
"harmonizedCode": "str",
"qualifierRenamers": [
{
"qualifier": "str",
"renames": "str"
}
],
"kit": {
"materialNotes": "str",
"components": [
{
"itemIdentifier": {
"sku": "str",
"id": 2
},
"qualifier": "str",
"qty": 1.0,
"nonSkuMaterial": "str"
}
]
},
"options": {
"inventoryUnit": {
"unitIdentifier": {
"name": "str",
"id": 2
},
"minimumStock": 1.0,
"maximumStock": 1.0,
"reorderQuantity": 1.0,
"inventoryMethod": 1
},
"secondaryUnit": {
"inventoryAlso": true,
"upc": "str",
"unitIdentifier": {
"name": "str",
"id": 2
},
"inventoryUnitsPerUnit": 3.0
},
"packageUnit": {
"imperial": {
"netWeight": 1.0,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"metric": {
"netWeight": 1.0,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"upc": "str",
"unitIdentifier": {
"name": "str",
"id": 2
},
"inventoryUnitsPerUnit": 2.0
},
"trackBys": {
"trackLotNumber": 0,
"trackSerialNumber": 0,
"trackExpirationDate": 0,
"trackCost": 0,
"outboundMobileSerialization": 0,
"autoHoldExpirationDaysThreshold": 1,
"isPickLotNumberRequired": true,
"isPickSerialNumberRequired": true,
"isPickExpirationDateRequired": true
},
"pallets": {
"typeIdentifier": {
"name": "str",
"id": 2
},
"tie": 1.0,
"high": 1.0,
"qty": 1.0,
"imperial": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"metric": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"upc": "str"
},
"hazMat": {
"isHazMat": true,
"id": "str",
"shippingName": "str",
"hazardClass": "str",
"packingGroup": "str",
"flashPoint": "str",
"labelCode": "str",
"flag": "str"
},
"directedPutAway": {
"locationZones": "str",
"palletLocationZones": "str",
"overAllocLocationZones": "str",
"preferredLocationIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
},
"forceIntoPreferredLocation": true,
"allowMixedItemStorage": true,
"allowMixedLotStorage": true,
"mixedExpirationDaysThreshold": 1
},
"daysBetweenCounts": 1,
"autoHoldOnReceive": true
},
"replenishment": true,
"_embedded": {
"item": [
{
"qualifier": "str"
}
]
}
}
]
}
}
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.