Partially update an order from user
PATCH
/orders/{direction}/{orderID}/fromuser
200,4XXDescription
Only FirstName, LastName, and Email can be updated.
Primarily used to facilitate guest checkout scenarios.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessOrderAdminShopper
Parameters
Name | Type | Description | Possible Values | |
---|---|---|---|---|
direction | Required | string | Direction of the order, from the current user's perspective. | Incoming, Outgoing, All |
orderID | Required | string | ID of the order. | --- |
Request Body
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
ID | string | --- | 100 characters | --- | ||
Username | string | --- | 100 characters | --- | ||
Password | string | password | --- | --- | ||
FirstName | string | --- | 100 characters | --- | ||
LastName | string | --- | 100 characters | --- | ||
string | --- | 200 characters | --- | |||
Phone | string | --- | 100 characters | --- | ||
TermsAccepted | string | date-time | --- | --- | ||
Active | boolean | --- | --- | --- | ||
xp | object | --- | --- | --- |
Response Body
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
ID | string | --- | 100 characters | --- | ||
FromUser | Read Only | object | --- | --- | --- | |
FromCompanyID | string | --- | --- | --- | ||
ToCompanyID | string | --- | --- | --- | ||
FromUserID | string | --- | --- | --- | ||
BillingAddressID | string | --- | --- | --- | ||
BillingAddress | 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 | --- | --- | ||
Fees | Read Only | 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 | --- | --- | --- |