Resource:Collection: of orderC# Rel Const:Rels.OrderSvc.OrdersURI template:{?pgsiz,pgnum,rql,sort,detail,itemdetail,markforlistid,skulist,skucontains,hvpbatchname}Obtain URI from:
Get list of orders.
Success status: 200
Name | Data Type | Description |
---|---|---|
pgsiz | int | must be positive; limit 1000, specifying more is an error; default 100; 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 |
detail | Common.Enum.OrderChildren | comma-delim list, for inclusion in response, default None |
- None | ||
- OrderItems | ||
- BillingDetails | ||
- SavedElements | ||
- Packages | ||
- Contacts | ||
- ProposedBilling | ||
- OutboundSerialNumbers | ||
- SmallParcel | ||
- ParcelOptions | ||
- Inserts | ||
- All | ||
itemdetail | Common.Enum.OrderItemChildren | comma-delim list, for inclusion in response, default None; if other than None, detail must include OrderItems; All = SavedElements,Allocations |
- None | ||
- SavedElements | ||
- Allocations | ||
- All | ||
- AllocationsWithDetail | ||
markforlistid | int | match orders containing "MarkForID" saved element in given MarkForList |
skulist | string | comma-delim list of skus, match any order with a line item for any given sku |
skucontains | string | single partial sku, match any order with a line item for given partial sku |
hvpbatchname | string | match orders for the given high-volume processing batch name |
Type | Description | |
---|---|---|
TotalResults | int | |
ResourceList | IList<Order.Models.Order> | |
ReadOnly | Order.Models.OrderReadOnly | |
OrderId | int | |
AsnCandidate | int | |
RouteCandidate | int | |
FullyAllocated | bool | |
ImportModuleId | int? ... | |
ExportModuleIds | string | |
DeferNotification | bool | |
IsClosed | bool | |
ProcessDate | DateTime? ... | |
PickStarted | bool | Set to True when user starts pickjob |
PickDoneDate | DateTime? ... | Stored and displayed in warehouse time |
PickTicketPrintDate | DateTime? ... | Stored and displayed in warehouse time |
PackStarted | bool | Set to True when the first package is created |
PackDoneDate | DateTime? ... | Stored in server time, displayed in warehouse time |
LabelsExported | bool? ... | |
InvoiceExportedDate | DateTime? ... | |
InvoiceDeliveredDate | DateTime? ... | |
LoadedState | Order.Models.LoadOutState | |
- 1: Loaded | ||
- 2: LoadedIncomplete | ||
LoadOutDoneDate | DateTime? ... | Stored and displayed in warehouse time |
ReallocatedAfterPickTicketDate | DateTime? ... | |
RouteSent | bool | |
AsnSentDate | DateTime? ... | |
AsnSent | bool? ... | |
PkgsExported | bool? ... | |
BatchIdentifier | Generic.Models.BatchIdentifier | |
NameKey | Generic.Models.BatchNameKey | |
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
Name | string | |
BatchCreationDate | DateTime? ... | |
Id | int | |
SmallParcelShipDate | DateTime? ... | Stored in server time, displayed in warehouse time, SmallParcelResponse.ShipDate |
Packages | IList<Order.Models.PackageInfo> | |
PackageId | int | |
PackageTypeId | int | |
PackageDefIdentifier | Generic.Models.PackageDefIdentifier | |
Name | string | |
Id | int | |
Length | decimal? ... | |
Width | decimal? ... | |
Height | decimal? ... | |
Weight | decimal? ... | |
CodAmount | decimal? ... | |
InsuredAmount | decimal? ... | |
TrackingNumber | string | |
Description | string | |
CreateDate | DateTime | |
Oversize | bool? ... | |
Cod | bool? ... | |
Ucc128 | int? ... | |
CartonId | string | |
Label | Byte[] | |
PackageContents | IList<Order.Models.PackageContentInfo> | |
PackageContentId | int | |
PackageId | int | |
OrderItemId | int | |
ReceiveItemId | int | |
OrderItemPickExceptionId | int? ... | |
Qty | decimal | |
LotNumber | string | |
SerialNumber | string | |
ExpirationDate | DateTime? ... | |
CreateDate | DateTime | |
SerialNumbers | IEnumerable<string> | |
ShippingPalletId | int? ... | |
ShippingPallets | IList<Order.Models.ShippingPallet> | |
ShippingPalletId | int | |
UCC128 | string | |
Weight | decimal? ... | |
PackageIds | IEnumerable<int> | |
OutboundSerialNumbers | IEnumerable<Order.Models.OutboundSerialNumbers> | |
ItemIdentifier | Generic.Models.ItemIdentifier | |
Sku | string | |
Id | int | |
Qualifier | string | |
SerialNumbers | IEnumerable<string> | |
ParcelLabelType | Common.Enum.ParcelLabelType | |
- 0: None | ||
- 1: Pdf | ||
- 2: Zpl | ||
ShipDate | DateTime? ... | |
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
FacilityIdentifier | Generic.Models.FacilityIdentifier | |
Name | string | |
Id | int | |
WarehouseTransactionSourceType | 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 | ||
TransactionEntryType | 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 trhough which this order was imported |
Name | string | |
Id | int | |
CreationDate | DateTime? ... | |
CreatedByIdentifier | Generic.Models.UserIdentifier | |
Name | string | |
Id | int | |
LastModifiedDate | DateTime? ... | |
LastModifiedByIdentifier | Generic.Models.UserIdentifier | |
Name | string | |
Id | int | |
Status | Common.Enum.WarehouseTransactionApiStatus | For GET of orders and receivers, the value is reliable. For rql for orders, this property is reliable only for "Canceled" status; otherwise use the IsClosed property. |
- 0: Open | Has not yet been confirmed | |
- 1: Closed | Has been confirmed | |
- 2: Canceled | Has been canceled | |
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 | |
ParcelResponse | Order.Models.ParcelResponse | |
OrderId | int | |
TrackingNumbers | IEnumerable<string> | |
ReturnTrackingNumbers | IEnumerable<string> | |
Links | IList<WebApi.Hal.Link> | |
- edit | ||
- /rels/orders/fulfillinv | The fullfilment invoicing part of the order. | |
- /rels/orders/orderrouting | The routing part of the order. | |
- /rels/orders/items | ||
- /rels/orders/packages | ||
- /rels/customers/customer | ||
- /rels/properties/facility | ||
- /rels/orders/ordercancel | Operator to cancel the order. | |
- /rels/orders/orderconfirm | Operator to confirm (ship) the order. | |
- /rels/orders/packagesgenerate | Operator to generate packages for the order. | |
- /rels/orders/packagesconsolidate | Operator to consolidate packages for the order. | |
- /rels/orders/packagessummarize | Operator to update the package summary for the order. | |
- /rels/inventory/stocksummariesfororder | Get inventory availability for items in the order. | |
- /rels/orders/ordercomplete | Operator to indicate creation of the order is complete. | |
- /rels/orders/orderallocate | Operator to allocate the order. | |
- /rels/orders/orderdeallocate | Operator to deallocate the order. | |
- /rels/orders/ordersplit | Operator to split the order. | |
- /rels/orders/ordershort | Operator to short the order. | |
- /rels/orders/orderfilesummaries | Info on files attached to order. | |
- /rels/orders/orderunconfirm | Operator to unconfirm the order. | |
- /rels/customers/itemsummaries | Summaries of item descriptions | |
- /rels/orders/batch | Batch containing order. | |
- /rels/orders/orderasnmark | Operator to mark for Advance Shipping Notice. | |
- /rels/orders/orderasnsent | Operator to indicate Advance Shipping Notice has been sent | |
- /rels/orders/orderpickticketdatesetter | Sets this order's pick ticket date to NOW | |
- /rels/orders/orderpackstarter | Sets this order's packstarted to true | |
- /rels/orders/orderpackevent | Adds a pack event to this order | |
- /rels/orders/orderpackdatesetter | Sets this order's pack done date to NOW | |
- /rels/orders/bolgenerate | Operator to generate a bill of lading id | |
- /rels/orders/orderparcelcanceler | Operator to cancel the parcel shipment. | |
- /rels/orders/orderparcelfinalizer | Operator to finalize the parcel shipment. | |
- /rels/orders/orderparcelshippinglabel | Operator to get shipping label(s). | |
- /rels/orders/orderparcelreturnlabel | Operator to get return label(s). | |
- /rels/orders/orderparceltmwexporter | Operator to export order to TMW | |
- /rels/orders/orderparcelinjectlabel | Operator to inject shipping/return label(s). | |
- /rels/orders/orderparcelinjectlabels | Operator to inject shipping/return label(s) on multiple orders. | |
- /rels/orders/orderparcelinjectreturnlabel | Operator to inject return label(s). | |
- /rels/orders/pickjob | Operator to get the pick job id | |
- /rels/orders/ordertransfer | Operator to change facility. | |
- /rels/orders/savedelements | ||
- /rels/properties/contact | ||
Links | IList<WebApi.Hal.Link> | |
- next | ||
- prev |
{ "totalResults": 1, "_embedded": { "http://api.3plCentral.com/rels/orders/order": [ { "readOnly": { "orderId": 1, "asnCandidate": 2, "routeCandidate": 3, "fullyAllocated": true, "importModuleId": 1, "exportModuleIds": "str", "deferNotification": true, "isClosed": true, "processDate": "2016-12-25T23:00:00", "pickStarted": true, "pickDoneDate": "2016-12-25T23:00:00", "pickTicketPrintDate": "2016-12-25T23:00:00", "packStarted": true, "packDoneDate": "2016-12-25T23:00:00", "labelsExported": true, "invoiceExportedDate": "2016-12-25T23:00:00", "invoiceDeliveredDate": "2016-12-25T23:00:00", "loadedState": 0, "loadOutDoneDate": "2016-12-25T23:00:00", "reallocatedAfterPickTicketDate": "2016-12-25T23:00:00", "routeSent": true, "asnSentDate": "2016-12-25T23:00:00", "asnSent": true, "pkgsExported": true, "batchIdentifier": { "nameKey": { "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "name": "str" }, "batchCreationDate": "2016-12-25T23:00:00", "id": 1 }, "smallParcelShipDate": "2016-12-25T23:00:00", "packages": [ { "packageId": 1, "packageTypeId": 2, "packageDefIdentifier": { "name": "str", "id": 2 }, "length": 1.0, "width": 1.0, "height": 1.0, "weight": 1.0, "codAmount": 1.0, "insuredAmount": 1.0, "trackingNumber": "str", "description": "str", "createDate": "2016-12-25T23:00:00", "oversize": true, "cod": true, "ucc128": 1, "cartonId": "str", "label": "QA==", "packageContents": [ { "packageContentId": 1, "packageId": 2, "orderItemId": 3, "receiveItemId": 4, "orderItemPickExceptionId": 1, "qty": 5.0, "lotNumber": "str", "serialNumber": "str", "expirationDate": "2016-12-25T23:00:00", "createDate": "2016-12-25T23:00:00", "serialNumbers": [ "str" ] } ], "shippingPalletId": 1 } ], "shippingPallets": [ { "shippingPalletId": 1, "ucC128": "str", "weight": 1.0, "packageIds": [ 1 ] } ], "outboundSerialNumbers": [ { "itemIdentifier": { "sku": "str", "id": 2 }, "qualifier": "str", "serialNumbers": [ "str" ] } ], "parcelLabelType": 0, "shipDate": "2016-12-25T23:00:00", "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "facilityIdentifier": { "name": "str", "id": 2 }, "warehouseTransactionSourceType": 0, "transactionEntryType": 0, "importChannelIdentifier": { "name": "str", "id": 2 }, "creationDate": "2016-12-25T23:00:00", "createdByIdentifier": { "name": "str", "id": 2 }, "lastModifiedDate": "2016-12-25T23:00:00", "lastModifiedByIdentifier": { "name": "str", "id": 2 }, "status": 0 }, "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" } ], "parcelResponse": { "orderId": 1, "trackingNumbers": [ "str" ], "returnTrackingNumbers": [ "str" ] }, "_embedded": { "http://api.3plCentral.com/rels/orders/item": [ { "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 } ] } } ] } }
Create a single order.
Success status: 201; ETag response header supplied
Type | Description | |
---|---|---|
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 | |
ParcelResponse | Order.Models.ParcelResponse | |
OrderId | int | |
TrackingNumbers | IEnumerable<string> | |
ReturnTrackingNumbers | IEnumerable<string> |
Sample content-type: application/hal+json |
{ "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, "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" } ], "parcelResponse": { "orderId": 1, "trackingNumbers": [ "str" ], "returnTrackingNumbers": [ "str" ] }, "_embedded": { "http://api.3plCentral.com/rels/orders/item": [ { "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 } ] } }
Type | Description | |
---|---|---|
ReadOnly | Order.Models.OrderReadOnly | |
OrderId | int | |
AsnCandidate | int | |
RouteCandidate | int | |
FullyAllocated | bool | |
ImportModuleId | int? ... | |
ExportModuleIds | string | |
DeferNotification | bool | |
IsClosed | bool | |
ProcessDate | DateTime? ... | |
PickStarted | bool | Set to True when user starts pickjob |
PickDoneDate | DateTime? ... | Stored and displayed in warehouse time |
PickTicketPrintDate | DateTime? ... | Stored and displayed in warehouse time |
PackStarted | bool | Set to True when the first package is created |
PackDoneDate | DateTime? ... | Stored in server time, displayed in warehouse time |
LabelsExported | bool? ... | |
InvoiceExportedDate | DateTime? ... | |
InvoiceDeliveredDate | DateTime? ... | |
LoadedState | Order.Models.LoadOutState | |
- 1: Loaded | ||
- 2: LoadedIncomplete | ||
LoadOutDoneDate | DateTime? ... | Stored and displayed in warehouse time |
ReallocatedAfterPickTicketDate | DateTime? ... | |
RouteSent | bool | |
AsnSentDate | DateTime? ... | |
AsnSent | bool? ... | |
PkgsExported | bool? ... | |
BatchIdentifier | Generic.Models.BatchIdentifier | |
NameKey | Generic.Models.BatchNameKey | |
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
Name | string | |
BatchCreationDate | DateTime? ... | |
Id | int | |
SmallParcelShipDate | DateTime? ... | Stored in server time, displayed in warehouse time, SmallParcelResponse.ShipDate |
Packages | IList<Order.Models.PackageInfo> | |
PackageId | int | |
PackageTypeId | int | |
PackageDefIdentifier | Generic.Models.PackageDefIdentifier | |
Name | string | |
Id | int | |
Length | decimal? ... | |
Width | decimal? ... | |
Height | decimal? ... | |
Weight | decimal? ... | |
CodAmount | decimal? ... | |
InsuredAmount | decimal? ... | |
TrackingNumber | string | |
Description | string | |
CreateDate | DateTime | |
Oversize | bool? ... | |
Cod | bool? ... | |
Ucc128 | int? ... | |
CartonId | string | |
Label | Byte[] | |
PackageContents | IList<Order.Models.PackageContentInfo> | |
PackageContentId | int | |
PackageId | int | |
OrderItemId | int | |
ReceiveItemId | int | |
OrderItemPickExceptionId | int? ... | |
Qty | decimal | |
LotNumber | string | |
SerialNumber | string | |
ExpirationDate | DateTime? ... | |
CreateDate | DateTime | |
SerialNumbers | IEnumerable<string> | |
ShippingPalletId | int? ... | |
ShippingPallets | IList<Order.Models.ShippingPallet> | |
ShippingPalletId | int | |
UCC128 | string | |
Weight | decimal? ... | |
PackageIds | IEnumerable<int> | |
OutboundSerialNumbers | IEnumerable<Order.Models.OutboundSerialNumbers> | |
ItemIdentifier | Generic.Models.ItemIdentifier | |
Sku | string | |
Id | int | |
Qualifier | string | |
SerialNumbers | IEnumerable<string> | |
ParcelLabelType | Common.Enum.ParcelLabelType | |
- 0: None | ||
- 1: Pdf | ||
- 2: Zpl | ||
ShipDate | DateTime? ... | |
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
FacilityIdentifier | Generic.Models.FacilityIdentifier | |
Name | string | |
Id | int | |
WarehouseTransactionSourceType | 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 | ||
TransactionEntryType | 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 trhough which this order was imported |
Name | string | |
Id | int | |
CreationDate | DateTime? ... | |
CreatedByIdentifier | Generic.Models.UserIdentifier | |
Name | string | |
Id | int | |
LastModifiedDate | DateTime? ... | |
LastModifiedByIdentifier | Generic.Models.UserIdentifier | |
Name | string | |
Id | int | |
Status | Common.Enum.WarehouseTransactionApiStatus | For GET of orders and receivers, the value is reliable. For rql for orders, this property is reliable only for "Canceled" status; otherwise use the IsClosed property. |
- 0: Open | Has not yet been confirmed | |
- 1: Closed | Has been confirmed | |
- 2: Canceled | Has been canceled | |
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 | |
ParcelResponse | Order.Models.ParcelResponse | |
OrderId | int | |
TrackingNumbers | IEnumerable<string> | |
ReturnTrackingNumbers | IEnumerable<string> | |
Links | IList<WebApi.Hal.Link> | |
- edit | ||
- /rels/orders/fulfillinv | The fullfilment invoicing part of the order. | |
- /rels/orders/orderrouting | The routing part of the order. | |
- /rels/orders/items | ||
- /rels/orders/packages | ||
- /rels/customers/customer | ||
- /rels/properties/facility | ||
- /rels/orders/ordercancel | Operator to cancel the order. | |
- /rels/orders/orderconfirm | Operator to confirm (ship) the order. | |
- /rels/orders/packagesgenerate | Operator to generate packages for the order. | |
- /rels/orders/packagesconsolidate | Operator to consolidate packages for the order. | |
- /rels/orders/packagessummarize | Operator to update the package summary for the order. | |
- /rels/inventory/stocksummariesfororder | Get inventory availability for items in the order. | |
- /rels/orders/ordercomplete | Operator to indicate creation of the order is complete. | |
- /rels/orders/orderallocate | Operator to allocate the order. | |
- /rels/orders/orderdeallocate | Operator to deallocate the order. | |
- /rels/orders/ordersplit | Operator to split the order. | |
- /rels/orders/ordershort | Operator to short the order. | |
- /rels/orders/orderfilesummaries | Info on files attached to order. | |
- /rels/orders/orderunconfirm | Operator to unconfirm the order. | |
- /rels/customers/itemsummaries | Summaries of item descriptions | |
- /rels/orders/batch | Batch containing order. | |
- /rels/orders/orderasnmark | Operator to mark for Advance Shipping Notice. | |
- /rels/orders/orderasnsent | Operator to indicate Advance Shipping Notice has been sent | |
- /rels/orders/orderpickticketdatesetter | Sets this order's pick ticket date to NOW | |
- /rels/orders/orderpackstarter | Sets this order's packstarted to true | |
- /rels/orders/orderpackevent | Adds a pack event to this order | |
- /rels/orders/orderpackdatesetter | Sets this order's pack done date to NOW | |
- /rels/orders/bolgenerate | Operator to generate a bill of lading id | |
- /rels/orders/orderparcelcanceler | Operator to cancel the parcel shipment. | |
- /rels/orders/orderparcelfinalizer | Operator to finalize the parcel shipment. | |
- /rels/orders/orderparcelshippinglabel | Operator to get shipping label(s). | |
- /rels/orders/orderparcelreturnlabel | Operator to get return label(s). | |
- /rels/orders/orderparceltmwexporter | Operator to export order to TMW | |
- /rels/orders/orderparcelinjectlabel | Operator to inject shipping/return label(s). | |
- /rels/orders/orderparcelinjectlabels | Operator to inject shipping/return label(s) on multiple orders. | |
- /rels/orders/orderparcelinjectreturnlabel | Operator to inject return label(s). | |
- /rels/orders/pickjob | Operator to get the pick job id | |
- /rels/orders/ordertransfer | Operator to change facility. | |
- /rels/orders/savedelements | ||
- /rels/properties/contact |
{ "readOnly": { "orderId": 1, "asnCandidate": 2, "routeCandidate": 3, "fullyAllocated": true, "importModuleId": 1, "exportModuleIds": "str", "deferNotification": true, "isClosed": true, "processDate": "2016-12-25T23:00:00", "pickStarted": true, "pickDoneDate": "2016-12-25T23:00:00", "pickTicketPrintDate": "2016-12-25T23:00:00", "packStarted": true, "packDoneDate": "2016-12-25T23:00:00", "labelsExported": true, "invoiceExportedDate": "2016-12-25T23:00:00", "invoiceDeliveredDate": "2016-12-25T23:00:00", "loadedState": 0, "loadOutDoneDate": "2016-12-25T23:00:00", "reallocatedAfterPickTicketDate": "2016-12-25T23:00:00", "routeSent": true, "asnSentDate": "2016-12-25T23:00:00", "asnSent": true, "pkgsExported": true, "batchIdentifier": { "nameKey": { "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "name": "str" }, "batchCreationDate": "2016-12-25T23:00:00", "id": 1 }, "smallParcelShipDate": "2016-12-25T23:00:00", "packages": [ { "packageId": 1, "packageTypeId": 2, "packageDefIdentifier": { "name": "str", "id": 2 }, "length": 1.0, "width": 1.0, "height": 1.0, "weight": 1.0, "codAmount": 1.0, "insuredAmount": 1.0, "trackingNumber": "str", "description": "str", "createDate": "2016-12-25T23:00:00", "oversize": true, "cod": true, "ucc128": 1, "cartonId": "str", "label": "QA==", "packageContents": [ { "packageContentId": 1, "packageId": 2, "orderItemId": 3, "receiveItemId": 4, "orderItemPickExceptionId": 1, "qty": 5.0, "lotNumber": "str", "serialNumber": "str", "expirationDate": "2016-12-25T23:00:00", "createDate": "2016-12-25T23:00:00", "serialNumbers": [ "str" ] } ], "shippingPalletId": 1 } ], "shippingPallets": [ { "shippingPalletId": 1, "ucC128": "str", "weight": 1.0, "packageIds": [ 1 ] } ], "outboundSerialNumbers": [ { "itemIdentifier": { "sku": "str", "id": 2 }, "qualifier": "str", "serialNumbers": [ "str" ] } ], "parcelLabelType": 0, "shipDate": "2016-12-25T23:00:00", "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "facilityIdentifier": { "name": "str", "id": 2 }, "warehouseTransactionSourceType": 0, "transactionEntryType": 0, "importChannelIdentifier": { "name": "str", "id": 2 }, "creationDate": "2016-12-25T23:00:00", "createdByIdentifier": { "name": "str", "id": 2 }, "lastModifiedDate": "2016-12-25T23:00:00", "lastModifiedByIdentifier": { "name": "str", "id": 2 }, "status": 0 }, "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" } ], "parcelResponse": { "orderId": 1, "trackingNumbers": [ "str" ], "returnTrackingNumbers": [ "str" ] }, "_embedded": { "http://api.3plCentral.com/rels/orders/item": [ { "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 } ] } }
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.