Partially update a line item shipping address.
PATCH
/orders/{direction}/{orderID}/lineitems/{lineItemID}/shipto
200Description
Partially update the Shipping Address of the Line Item. Not allowed on unsubmitted Line Items where ShippingAddressID 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. | --- |
| lineItemID | Required | string | ID of the line item. | --- |
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 | --- | ||
| 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 | --- | --- | --- | |
| Variant | Read Only | object | --- | --- | --- | |
| ShippingAddress | Read Only | object | --- | --- | --- | |
| ShipFromAddress | Read Only | object | --- | --- | --- | |
| SupplierID | Read Only | string | --- | --- | --- | |
| InventoryRecordID | string | --- | --- | --- | ||
| PriceScheduleID | Read Only | string | --- | --- | --- | |
| IsOnSale | Read Only | boolean | --- | --- | --- | |
| PriceOverridden | Read Only | boolean | --- | --- | --- | |
| Specs | array | --- | --- | --- | ||
| IncomingOrderID | Read Only | string | --- | --- | --- | |
| OutgoingOrderID | Read Only | string | --- | --- | --- | |
| xp | object | --- | --- | --- | ||
Partially update a line item shipping address.
PATCH
/orders/{direction}/{orderID}/lineitems/{lineItemID}/shipto
200Description
Partially update the Shipping Address of the Line Item. Not allowed on unsubmitted Line Items where ShippingAddressID 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. | --- |
| lineItemID | Required | string | ID of the line item. | --- |
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 | --- | ||
| 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 | --- | --- | --- | |
| Variant | Read Only | object | --- | --- | --- | |
| ShippingAddress | Read Only | object | --- | --- | --- | |
| ShipFromAddress | Read Only | object | --- | --- | --- | |
| SupplierID | Read Only | string | --- | --- | --- | |
| InventoryRecordID | string | --- | --- | --- | ||
| PriceScheduleID | Read Only | string | --- | --- | --- | |
| IsOnSale | Read Only | boolean | --- | --- | --- | |
| PriceOverridden | Read Only | boolean | --- | --- | --- | |
| Specs | array | --- | --- | --- | ||
| IncomingOrderID | Read Only | string | --- | --- | --- | |
| OutgoingOrderID | Read Only | string | --- | --- | --- | |
| xp | object | --- | --- | --- | ||