Sitecore OrderCloud Documentation

docs

Portal login

Set a ship to address.

PUT

/shipments/{shipmentID}/shipto

200

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 shipment's ToAddressID property instead.

Roles

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

FullAccessShipmentAdmin

Parameters

NameTypeDescriptionPossible Values
shipmentIDRequiredstringID of the shipment.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
CompanyNamestring---100 characters---
FirstNamestring---100 characters---
LastNamestring---100 characters---
Street1Requiredstring---100 characters---
Street2string---100 characters---
CityRequiredstring---100 characters---
StateRequiredstring---100 characters---
ZipRequiredstring---100 characters---
CountryRequiredstring---2 characters---
Phonestring---100 characters---
AddressNamestring---100 characters---
xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
BuyerIDstring---------
Shipperstring---------

DateShippedstringdate-time------

DateDeliveredstringdate-time------
TrackingNumberstring---3000 characters---
Costnumberfloat------

OwnerIDstring---------

xpobject---------
Accountstring---------
FromAddressIDstring---------

ToAddressIDstring---------
FromAddressRead Onlyobject---------
ToAddressRead Onlyobject---------
Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore