Sitecore API catalog/OrderCloud/
/
Set a ship to address

Set a ship to address

Request

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.

Security
OAuth2(Required scopes: FullAccessShipmentAdmin)
Path
shipmentIDstringrequired

ID of the shipment.

Bodyapplication/jsonrequired
Street1string, <= 100 charactersrequired
Example:""
Citystring, <= 100 charactersrequired
Example:""
Countrystring, <= 2 charactersrequired
Example:""
IDstring, <= 100 characters
Example:""
CompanyNamestring, <= 100 characters
Example:""
FirstNamestring, <= 100 characters
Example:""
LastNamestring, <= 100 characters
Example:""
Street2string, <= 100 characters
Example:""
Statestring, <= 100 characters
Example:""
Zipstring, <= 100 characters
Example:""
Phonestring, <= 100 characters
Example:""
AddressNamestring, <= 100 characters
Example:""
xpobject
Example:
{}
curl -i -X PUT \
  'https://api.ordercloud.io/v1/shipments/{shipmentID}/shipto' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ID": "",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CompanyName": "",
    "FirstName": "",
    "LastName": "",
    "Street1": "",
    "Street2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Country": "",
    "Phone": "",
    "AddressName": "",
    "xp": {}
  }'

Responses

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.

Bodyapplication/json
IDstring, <= 100 characters
Example:""
BuyerIDstring
Example:""
Shipperstring

For reference only, does not influence any OrderCloud behavior.

Example:""
DateShippedstring, (date-time)

In order to properly trigger OrderShipped emails, this date must be NULL on initial create. Update with the date only when all of the Shipment items have been created. Once all of an order's items exist on a shipment that has a DateShipped populated the OrderShipped message sender will trigger and Order.Status will be updated to Complete.

Example:"2018-01-01T00:00:00-06:00"
DateDeliveredstring, (date-time)
Example:"2018-01-01T00:00:00-06:00"
TrackingNumberstring, <= 3000 characters
Example:""
Costnumber, (float)

For reference only, does not influence any OrderCloud behavior.

Example:0
OwnerIDstring

ID of the organization that owns the shipment. Only the marketplace owner can override the OwnerID on create.

Example:""
xpobject
Example:
{}
Accountstring
Example:""
FromAddressIDstring

Marketplace owner or supplier AddressID where the product will be shipped from.

Example:""
ToAddressIDstring
Example:""
FromAddressobject(Address)read-only
Example:
{
  "ID": "",
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "CompanyName": "",
  "FirstName": "",
  "LastName": "",
  "Street1": "",
  "Street2": "",
  "City": "",
  "State": "",
  "Zip": "",
  "Country": "",
  "Phone": "",
  "AddressName": "",
  "xp": {}
}
ToAddressobject(Address)read-only
Example:
{
  "ID": "",
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "CompanyName": "",
  "FirstName": "",
  "LastName": "",
  "Street1": "",
  "Street2": "",
  "City": "",
  "State": "",
  "Zip": "",
  "Country": "",
  "Phone": "",
  "AddressName": "",
  "xp": {}
}
Response
{
  "ID": "",
  "BuyerID": "",
  "Shipper": "",
  "DateShipped": "2018-01-01T00:00:00-06:00",
  "DateDelivered": "2018-01-01T00:00:00-06:00",
  "TrackingNumber": "",
  "Cost": 0,
  "OwnerID": "",
  "xp": {},
  "Account": "",
  "FromAddressID": "",
  "ToAddressID": "",
  "FromAddress": {
    "ID": "",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CompanyName": "",
    "FirstName": "",
    "LastName": "",
    "Street1": "",
    "Street2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Country": "",
    "Phone": "",
    "AddressName": "",
    "xp": {}
  },
  "ToAddress": {
    "ID": "",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CompanyName": "",
    "FirstName": "",
    "LastName": "",
    "Street1": "",
    "Street2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Country": "",
    "Phone": "",
    "AddressName": "",
    "xp": {}
  }
}