Set a shipping address

PUT

/orders/{direction}/{orderID}/shipto

Description

Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's ShippingAddressID property instead. The address used will be populated on the ShippingAddress property of each LineItem.

Roles

At least one of the roles below is required to access this endpoint

FullAccess

OrderAdmin

Shopper

Parameters

Name	Type	Description	Possible Values
direction	`string`	Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.	Incoming, Outgoing, All
orderID	`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	Required	`string`	---	100 characters	---
Street2		`string`	---	100 characters	---
City	Required	`string`	---	100 characters	---
State	Required	`string`	---	100 characters	---
Zip	Required	`string`	---	100 characters	---
Country	Required	`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

---

Property Type Format Max Length Possible Values

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

---

Read Only

string

---

200 characters

---

Phone

Read Only

string

---

100 characters

---

TermsAccepted

Read Only

string

date-time

---

Active

Read Only

boolean

---

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

---

xp object --- --- ---