Sitecore OrderCloud Documentation

docs

Portal login

Create or update an address.

PUT

/buyers/{buyerID}/addresses/{addressID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

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

FullAccessAddressAdmin

Parameters

NameTypeDescriptionPossible Values
buyerIDRequiredstringID of the buyer.---
addressIDRequiredstringID of the address.---

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---
DateCreatedRead Onlystringdate-time------
CompanyNamestring---100 characters---
FirstNamestring---100 characters---
LastNamestring---100 characters---
Street1string---100 characters---
Street2string---100 characters---
Citystring---100 characters---
Statestring---100 characters---
Zipstring---100 characters---
Countrystring---2 characters---
Phonestring---100 characters---
AddressNamestring---100 characters---
xpobject---------

Create or update an address.

PUT

/buyers/{buyerID}/addresses/{addressID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

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

FullAccessAddressAdmin

Parameters

NameTypeDescriptionPossible Values
buyerIDRequiredstringID of the buyer.---
addressIDRequiredstringID of the address.---

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---
DateCreatedRead Onlystringdate-time------
CompanyNamestring---100 characters---
FirstNamestring---100 characters---
LastNamestring---100 characters---
Street1string---100 characters---
Street2string---100 characters---
Citystring---100 characters---
Statestring---100 characters---
Zipstring---100 characters---
Countrystring---2 characters---
Phonestring---100 characters---
AddressNamestring---100 characters---
xpobject---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore