Sitecore OrderCloud Documentation

docs

Portal Login

Create a new admin address.

POST

/addresses

201

Description

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Roles

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

FullAccessAdminAddressAdmin

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 a new admin address.

POST

/addresses

201

Description

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Roles

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

FullAccessAdminAddressAdmin

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