| Order | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| ID | | string | --- | 100 characters | --- | | | FromUser | Read Only | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | Read Only | string | --- | 100 characters | --- | | | CompanyID | Read Only | string | --- | --- | --- | | | Username | Read Only | string | --- | 100 characters | --- | | | Password | Read Only | string | password | --- | --- | | | FirstName | Read Only | string | --- | 100 characters | --- | | | LastName | Read Only | string | --- | 100 characters | --- | | | Email | Read Only | string | --- | 200 characters | --- | | | Phone | Read Only | string | --- | 100 characters | --- | | | TermsAccepted | Read Only | string | date-time | --- | --- | | | Active | Read Only | boolean | --- | --- | --- | | | xp | Read Only | object | --- | --- | --- | | | AvailableRoles | Read Only | array | --- | --- | --- | | | Locale | Read Only | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | Read Only | string | --- | 100 characters | --- | | | OwnerID | Read Only | string | --- | --- | --- | | | Currency | Read Only | string | --- | 100 characters | --- | | | Language | Read Only | string | --- | 100 characters | --- | |
| | DateCreated | Read Only | string | date-time | --- | --- | | | LastActive | Read Only | string | date-time | --- | --- | | | PasswordLastSetDate | Read Only | string | date-time | --- | --- | |
| | FromCompanyID | | string | --- | --- | --- | | | ToCompanyID | | string | --- | --- | --- | | | FromUserID | | string | --- | --- | --- | | | BillingAddressID | | string | --- | --- | --- | | | BillingAddress | Read Only | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | Read Only | string | --- | 100 characters | --- | | | DateCreated | Read Only | string | date-time | --- | --- | | | CompanyName | Read Only | string | --- | 100 characters | --- | | | FirstName | Read Only | string | --- | 100 characters | --- | | | LastName | Read Only | string | --- | 100 characters | --- | | | Street1 | Read Only | string | --- | 100 characters | --- | | | Street2 | Read Only | string | --- | 100 characters | --- | | | City | Read Only | string | --- | 100 characters | --- | | | State | Read Only | string | --- | 100 characters | --- | | | Zip | Read Only | string | --- | 100 characters | --- | | | Country | Read Only | string | --- | 2 characters | --- | | | Phone | Read Only | string | --- | 100 characters | --- | | | AddressName | Read Only | string | --- | 100 characters | --- | | | xp | Read Only | object | --- | --- | --- | |
| | ShippingAddressID | | string | --- | --- | --- | | | Comments | | string | --- | 2000 characters | --- | | | LineItemCount | Read Only | integer | int32 | --- | --- | | | Status | Read Only | string | --- | --- | Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled | | | DateCreated | Read Only | string | date-time | --- | --- | | | DateSubmitted | Read Only | string | date-time | --- | --- | | | DateApproved | Read Only | string | date-time | --- | --- | | | DateDeclined | Read Only | string | date-time | --- | --- | | | DateCanceled | Read Only | string | date-time | --- | --- | | | DateCompleted | Read Only | string | date-time | --- | --- | | | LastUpdated | Read Only | string | date-time | --- | --- | | | Subtotal | Read Only | number | float | --- | --- | | | ShippingCost | | number | float | --- | --- | | | TaxCost | | number | float | --- | --- | | | Gratuity | | number | float | --- | --- | | | PromotionDiscount | Read Only | number | float | --- | --- | | | Currency | Read Only | string | --- | --- | --- | | | Total | Read Only | number | float | --- | --- | | | IsSubmitted | Read Only | boolean | --- | --- | --- | | | SubscriptionID | Read Only | string | --- | --- | --- | | | xp | | object | --- | --- | --- | |
|
| LineItems | | array | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| ID | | string | --- | 100 characters | --- | | | ProductID | | string | --- | --- | --- | | | Quantity | | integer | int32 | --- | --- | | | BundleItemID | Read Only | string | --- | --- | --- | | | IsBundle | Read Only | boolean | --- | --- | --- | | | DateAdded | Read Only | string | date-time | --- | --- | | | QuantityShipped | Read Only | integer | int32 | --- | --- | | | UnitPrice | | number | float | --- | --- | | | PromotionDiscount | Read Only | number | float | --- | --- | | | LineTotal | Read Only | number | float | --- | --- | | | LineSubtotal | Read Only | number | float | --- | --- | | | CostCenter | | string | --- | --- | --- | | | DateNeeded | | string | date-time | --- | --- | | | ShippingAccount | | string | --- | --- | --- | | | ShippingAddressID | | string | --- | --- | --- | | | ShipFromAddressID | | string | --- | --- | --- | | | Product | Read Only | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | Read Only | string | --- | 100 characters | --- | | | Name | Read Only | string | --- | --- | --- | | | Description | Read Only | string | --- | --- | --- | | | Returnable | Read Only | boolean | --- | --- | --- | | | QuantityMultiplier | Read Only | integer | int32 | --- | --- | | | ShipWeight | Read Only | number | float | --- | --- | | | ShipHeight | Read Only | number | float | --- | --- | | | ShipWidth | Read Only | number | float | --- | --- | | | ShipLength | Read Only | number | float | --- | --- | | | DefaultSupplierID | Read Only | string | --- | --- | --- | | | ParentID | Read Only | string | --- | --- | --- | | | xp | Read Only | object | --- | --- | --- | |
| | Variant | Read Only | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | Read Only | string | --- | 100 characters | --- | | | Name | Read Only | string | --- | --- | --- | | | Description | Read Only | string | --- | --- | --- | | | ShipWeight | Read Only | number | float | --- | --- | | | ShipHeight | Read Only | number | float | --- | --- | | | ShipWidth | Read Only | number | float | --- | --- | | | ShipLength | Read Only | number | float | --- | --- | | | xp | Read Only | object | --- | --- | --- | |
| | ShippingAddress | Read Only | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | Read Only | string | --- | 100 characters | --- | | | DateCreated | Read Only | string | date-time | --- | --- | | | CompanyName | Read Only | string | --- | 100 characters | --- | | | FirstName | Read Only | string | --- | 100 characters | --- | | | LastName | Read Only | string | --- | 100 characters | --- | | | Street1 | Read Only | string | --- | 100 characters | --- | | | Street2 | Read Only | string | --- | 100 characters | --- | | | City | Read Only | string | --- | 100 characters | --- | | | State | Read Only | string | --- | 100 characters | --- | | | Zip | Read Only | string | --- | 100 characters | --- | | | Country | Read Only | string | --- | 2 characters | --- | | | Phone | Read Only | string | --- | 100 characters | --- | | | AddressName | Read Only | string | --- | 100 characters | --- | | | xp | Read Only | object | --- | --- | --- | |
| | ShipFromAddress | Read Only | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | Read Only | string | --- | 100 characters | --- | | | DateCreated | Read Only | string | date-time | --- | --- | | | CompanyName | Read Only | string | --- | 100 characters | --- | | | FirstName | Read Only | string | --- | 100 characters | --- | | | LastName | Read Only | string | --- | 100 characters | --- | | | Street1 | Read Only | string | --- | 100 characters | --- | | | Street2 | Read Only | string | --- | 100 characters | --- | | | City | Read Only | string | --- | 100 characters | --- | | | State | Read Only | string | --- | 100 characters | --- | | | Zip | Read Only | string | --- | 100 characters | --- | | | Country | Read Only | string | --- | 2 characters | --- | | | Phone | Read Only | string | --- | 100 characters | --- | | | AddressName | Read Only | string | --- | 100 characters | --- | | | xp | Read Only | object | --- | --- | --- | |
| | SupplierID | Read Only | string | --- | --- | --- | | | InventoryRecordID | | string | --- | --- | --- | | | PriceScheduleID | Read Only | string | --- | --- | --- | | | IsOnSale | Read Only | boolean | --- | --- | --- | | | PriceOverridden | Read Only | boolean | --- | --- | --- | | | Specs | | array | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| SpecID | | string | --- | --- | --- | | | Name | Read Only | string | --- | --- | --- | | | OptionID | | string | --- | --- | --- | | | Value | | string | --- | 2000 characters | --- | | | PriceMarkupType | | string | --- | --- | NoMarkup, AmountPerQuantity, AmountTotal, Percentage | | | PriceMarkup | | number | float | --- | --- | |
| | IncomingOrderID | Read Only | string | --- | --- | --- | | | OutgoingOrderID | Read Only | string | --- | --- | --- | | | InvitationID | BETARead Only | string | --- | --- | --- | | | xp | | object | --- | --- | --- | |
|
| OrderPromotions | | array | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| Amount | Read Only | number | float | --- | --- | | | LineItemID | Read Only | string | --- | --- | --- | | | AmountOverridden | Read Only | boolean | --- | --- | --- | | | DateApplied | Read Only | string | date-time | --- | --- | | | ID | | string | --- | 100 characters | --- | | | LineItemLevel | | boolean | --- | --- | --- | | | Code | | string | --- | 100 characters | --- | | | Name | | string | --- | 100 characters | --- | | | RedemptionLimit | | integer | int32 | --- | --- | | | RedemptionLimitPerUser | | integer | int32 | --- | --- | | | RedemptionCount | Read Only | integer | int32 | --- | --- | | | QuantityLimitPerOrder | | integer | int32 | --- | --- | | | ItemLimitPerOrder | | integer | int32 | --- | --- | | | ItemSortBy | | string | --- | 200 characters | --- | | | Description | | string | --- | 2000 characters | --- | | | FinePrint | | string | --- | 2000 characters | --- | | | StartDate | | string | date-time | --- | --- | | | ExpirationDate | | string | date-time | --- | --- | | | EligibleExpression | | string | --- | 400 characters | --- | | | ValueExpression | | string | --- | 1000 characters | --- | | | CanCombine | | boolean | --- | --- | --- | | | AllowAllBuyers | | boolean | --- | --- | --- | | | OwnerID | | string | --- | --- | --- | | | AutoApply | | boolean | --- | --- | --- | | | Active | | boolean | --- | --- | --- | | | UseIntegration | | boolean | --- | --- | --- | | | Priority | | integer | int32 | --- | --- | | | xp | | object | --- | --- | --- | |
|
| Subscription | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| ID | | string | --- | 100 characters | --- | | | Frequency | | integer | int32 | --- | --- | | | Interval | | string | --- | --- | Days, Weeks, Months | | | NextOrderDate | | string | date-time | --- | --- | | | LastOrderDate | Read Only | string | date-time | --- | --- | | | NotificationDate | Read Only | string | date-time | --- | --- | | | DateCreated | Read Only | string | date-time | --- | --- | | | EndDate | | string | date-time | --- | --- | | | Active | | boolean | --- | --- | --- | | | FromCompanyID | | string | --- | --- | --- | | | FromUserID | | string | --- | --- | --- | | | ToCompanyID | | string | --- | --- | --- | | | Payment | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| Type | | string | --- | --- | PurchaseOrder, CreditCard, SpendingAccount | | | CreditCardID | | string | --- | --- | --- | | | SpendingAccountID | | string | --- | --- | --- | |
| | BillingAddressID | | string | --- | --- | --- | | | ShippingAddressID | | string | --- | --- | --- | | | xp | | object | --- | --- | --- | |
|
| ShipEstimateResponse | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| ShipEstimates | | array | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | | string | --- | --- | --- | | | xp | | object | --- | --- | --- | | | SelectedShipMethodID | | string | --- | --- | --- | | | ShipEstimateItems | | array | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| LineItemID | | string | --- | --- | --- | | | Quantity | | integer | int32 | --- | --- | |
| | ShipMethods | | array | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | | string | --- | --- | --- | | | Name | | string | --- | --- | --- | | | Cost | | number | float | --- | --- | | | EstimatedTransitDays | | integer | int32 | --- | --- | | | xp | | object | --- | --- | --- | |
|
| | HttpStatusCode | | integer | int32 | --- | --- | | | UnhandledErrorBody | | string | --- | --- | --- | | | xp | | object | --- | --- | --- | | | Succeeded | | boolean | --- | --- | --- | |
|
| OrderCalculateResponse | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| LineItemOverrides | | array | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| LineItemID | | string | --- | --- | --- | | | UnitPrice | | number | float | --- | --- | | | Product | | object | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| ID | | string | --- | 100 characters | --- | | | Name | | string | --- | 100 characters | --- | | | Description | | string | --- | 2000 characters | --- | | | QuantityMultiplier | | integer | int32 | --- | --- | | | ShipWeight | | number | float | --- | --- | | | ShipHeight | | number | float | --- | --- | | | ShipWidth | | number | float | --- | --- | | | ShipLength | | number | float | --- | --- | | | DefaultSupplierID | | string | --- | --- | --- | | | Returnable | | boolean | --- | --- | --- | | | xp | | object | --- | --- | --- | |
| | PromotionOverrides | | array | --- | --- | --- | | | Property | Type | Format | Max Length | Possible Values |
|---|
| PromotionID | | string | --- | --- | --- | | | Amount | | number | float | --- | --- | |
| | InventoryRecordID | | string | --- | --- | --- | | | Remove | | boolean | --- | --- | --- | |
| | ShippingTotal | | number | float | --- | --- | | | TaxTotal | | number | float | --- | --- | | | HttpStatusCode | | integer | int32 | --- | --- | | | UnhandledErrorBody | | string | --- | --- | --- | | | xp | | object | --- | --- | --- | | | Succeeded | | boolean | --- | --- | --- | |
|
| OrderSubmitResponse | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| HttpStatusCode | | integer | int32 | --- | --- | | | UnhandledErrorBody | | string | --- | --- | --- | | | xp | | object | --- | --- | --- | | | Succeeded | | boolean | --- | --- | --- | |
|
| OrderSubmitForApprovalResponse | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| HttpStatusCode | | integer | int32 | --- | --- | | | UnhandledErrorBody | | string | --- | --- | --- | | | xp | | object | --- | --- | --- | | | Succeeded | | boolean | --- | --- | --- | |
|
| OrderApprovedResponse | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| HttpStatusCode | | integer | int32 | --- | --- | | | UnhandledErrorBody | | string | --- | --- | --- | | | xp | | object | --- | --- | --- | | | Succeeded | | boolean | --- | --- | --- | |
|
| SubscriptionIntegrationResponse | | object | --- | --- | --- | |
| Property | Type | Format | Max Length | Possible Values |
|---|
| HttpStatusCode | | integer | int32 | --- | --- | | | UnhandledErrorBody | | string | --- | --- | --- | | | xp | | object | --- | --- | --- | | | Succeeded | | boolean | --- | --- | --- | |
|