Sitecore API catalog/OrderCloud/
/
Create an address

Create an address

Request

Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them.

Security
OAuth2(Required scopes: FullAccessMeAddressAdmin)
Bodyapplication/jsonrequired
Street1string, <= 100 charactersrequired
Example:""
Citystring, <= 100 charactersrequired
Example:""
Countrystring, <= 2 charactersrequired
Example:""
Shippingboolean

Indicates whether this address can be used as a ShippingAddress on an order or line item.

Example:false
Billingboolean

Indicates whether this address can be used as a BillingAddress on an order.

Example:false
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 POST \
  https://api.ordercloud.io/v1/me/addresses \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ID": "",
    "Shipping": false,
    "Billing": false,
    "Editable": false,
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CompanyName": "",
    "FirstName": "",
    "LastName": "",
    "Street1": "",
    "Street2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Country": "",
    "Phone": "",
    "AddressName": "",
    "xp": {}
  }'

Responses

Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them.

Bodyapplication/json
IDstring, <= 100 charactersread-only
Example:""
Shippingboolean

Indicates whether this address can be used as a ShippingAddress on an order or line item.

Example:false
Billingboolean

Indicates whether this address can be used as a BillingAddress on an order.

Example:false
Editablebooleanread-only

Indicates whether this address can be edited by the current user.

Example:false
DateCreatedstring, (date-time)read-only
Example:"2018-01-01T00:00:00-06:00"
CompanyNamestring, <= 100 characters
Example:""
FirstNamestring, <= 100 characters
Example:""
LastNamestring, <= 100 characters
Example:""
Street1string, <= 100 characters
Example:""
Street2string, <= 100 characters
Example:""
Citystring, <= 100 characters
Example:""
Statestring, <= 100 characters
Example:""
Zipstring, <= 100 characters
Example:""
Countrystring, <= 2 characters
Example:""
Phonestring, <= 100 characters
Example:""
AddressNamestring, <= 100 characters
Example:""
xpobject
Example:
{}
Response
{
  "ID": "",
  "Shipping": false,
  "Billing": false,
  "Editable": false,
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "CompanyName": "",
  "FirstName": "",
  "LastName": "",
  "Street1": "",
  "Street2": "",
  "City": "",
  "State": "",
  "Zip": "",
  "Country": "",
  "Phone": "",
  "AddressName": "",
  "xp": {}
}