Set a ship to address.
PUT
/shipments/{shipmentID}/shipto
200Description
Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's ToAddressID property instead.
Parameters
| Name | Type | Description | Possible Values | |
|---|---|---|---|---|
| shipmentID | Required | string | ID of the shipment. | --- |
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 | --- | ||
| BuyerID | string | --- | --- | --- | ||
| Shipper | string | --- | --- | --- | ||
| DateShipped | string | date-time | --- | --- | ||
| DateDelivered | string | date-time | --- | --- | ||
| TrackingNumber | string | --- | 3000 characters | --- | ||
| Cost | number | float | --- | --- | ||
| OwnerID | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
| Account | string | --- | --- | --- | ||
| FromAddressID | string | --- | --- | --- | ||
| ToAddressID | string | --- | --- | --- | ||
| FromAddress | Read Only | object | --- | --- | --- | |
| ToAddress | Read Only | object | --- | --- | --- | |
Set a ship to address.
PUT
/shipments/{shipmentID}/shipto
200Description
Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's ToAddressID property instead.
Parameters
| Name | Type | Description | Possible Values | |
|---|---|---|---|---|
| shipmentID | Required | string | ID of the shipment. | --- |
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 | --- | ||
| BuyerID | string | --- | --- | --- | ||
| Shipper | string | --- | --- | --- | ||
| DateShipped | string | date-time | --- | --- | ||
| DateDelivered | string | date-time | --- | --- | ||
| TrackingNumber | string | --- | 3000 characters | --- | ||
| Cost | number | float | --- | --- | ||
| OwnerID | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
| Account | string | --- | --- | --- | ||
| FromAddressID | string | --- | --- | --- | ||
| ToAddressID | string | --- | --- | --- | ||
| FromAddress | Read Only | object | --- | --- | --- | |
| ToAddress | Read Only | object | --- | --- | --- | |