Split an order.
POST/orders/{direction}/{orderID}/split
200 Description
Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessOrderAdmin
Parameters
| Name | Type | Description | Possible Values |
|---|
| direction | Required | string | Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. | Incoming, Outgoing, All |
| orderID | Required | string | ID of the order. | --- |
Response Body
| Property | Type | Format | Max Length | Possible Values |
|---|
| OutgoingOrders | | array | --- | --- | --- | |
| 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 | --- | --- | | | 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 | --- | --- | | | PromotionDiscount | Read Only | number | float | --- | --- | | | Currency | Read Only | string | --- | --- | --- | | | Total | Read Only | number | float | --- | --- | | | IsSubmitted | Read Only | boolean | --- | --- | --- | | | SubscriptionID | Read Only | string | --- | --- | --- | | | xp | | object | --- | --- | --- | |
|
| RemainingLineItemIDs | | array | --- | --- | --- | |
Split an order.
POST/orders/{direction}/{orderID}/split
200 Description
Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessOrderAdmin
Parameters
| Name | Type | Description | Possible Values |
|---|
| direction | Required | string | Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all. | Incoming, Outgoing, All |
| orderID | Required | string | ID of the order. | --- |
Response Body
| Property | Type | Format | Max Length | Possible Values |
|---|
| OutgoingOrders | | array | --- | --- | --- | |
| 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 | --- | --- | | | 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 | --- | --- | | | PromotionDiscount | Read Only | number | float | --- | --- | | | Currency | Read Only | string | --- | --- | --- | | | Total | Read Only | number | float | --- | --- | | | IsSubmitted | Read Only | boolean | --- | --- | --- | | | SubscriptionID | Read Only | string | --- | --- | --- | | | xp | | object | --- | --- | --- | |
|
| RemainingLineItemIDs | | array | --- | --- | --- | |
