Partially update an order billing address.
PATCH
/orders/{direction}/{orderID}/billto
200Description
Not allowed on unsubmitted orders where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address.
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. Possible values: incoming, outgoing, all. | Incoming, Outgoing, All |
| orderID | Required | string | ID of the order. | --- |
Request Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| CompanyName | string | --- | 100 characters | --- | ||
| FirstName | string | --- | 100 characters | --- | ||
| LastName | string | --- | 100 characters | --- | ||
| Street1 | string | --- | 100 characters | --- | ||
| Street2 | string | --- | 100 characters | --- | ||
| City | string | --- | 100 characters | --- | ||
| State | string | --- | 100 characters | --- | ||
| Zip | string | --- | 100 characters | --- | ||
| Country | string | --- | 2 characters | --- | ||
| Phone | string | --- | 100 characters | --- | ||
| AddressName | string | --- | 100 characters | --- | ||
| 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 | --- | --- | ||
| PromotionDiscount | Read Only | number | float | --- | --- | |
| Currency | Read Only | string | --- | --- | --- | |
| Total | Read Only | number | float | --- | --- | |
| IsSubmitted | Read Only | boolean | --- | --- | --- | |
| SubscriptionID | Read Only | string | --- | --- | --- | |
| xp | object | --- | --- | --- | ||
Partially update an order billing address.
PATCH
/orders/{direction}/{orderID}/billto
200Description
Not allowed on unsubmitted orders where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address.
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. Possible values: incoming, outgoing, all. | Incoming, Outgoing, All |
| orderID | Required | string | ID of the order. | --- |
Request Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| CompanyName | string | --- | 100 characters | --- | ||
| FirstName | string | --- | 100 characters | --- | ||
| LastName | string | --- | 100 characters | --- | ||
| Street1 | string | --- | 100 characters | --- | ||
| Street2 | string | --- | 100 characters | --- | ||
| City | string | --- | 100 characters | --- | ||
| State | string | --- | 100 characters | --- | ||
| Zip | string | --- | 100 characters | --- | ||
| Country | string | --- | 2 characters | --- | ||
| Phone | string | --- | 100 characters | --- | ||
| AddressName | string | --- | 100 characters | --- | ||
| 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 | --- | --- | ||
| PromotionDiscount | Read Only | number | float | --- | --- | |
| Currency | Read Only | string | --- | --- | --- | |
| Total | Read Only | number | float | --- | --- | |
| IsSubmitted | Read Only | boolean | --- | --- | --- | |
| SubscriptionID | Read Only | string | --- | --- | --- | |
| xp | object | --- | --- | --- | ||