Sitecore OrderCloud Documentation

docs

Portal login

Set a billing address.

PUT

/cart/billto

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 order's BillingAddressID property instead.

Roles

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

FullAccessShopper

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---
FromUserRead Onlyobject---------

FromCompanyIDstring---------

ToCompanyIDstring---------

FromUserIDstring---------

BillingAddressIDstring---------
BillingAddressRead Onlyobject---------
ShippingAddressIDstring---------

Commentsstring---2000 characters---
LineItemCountRead Onlyintegerint32------
StatusRead Onlystring------Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled
DateCreatedRead Onlystringdate-time------
DateSubmittedRead Onlystringdate-time------

DateApprovedRead Onlystringdate-time------
DateDeclinedRead Onlystringdate-time------
DateCanceledRead Onlystringdate-time------
DateCompletedRead Onlystringdate-time------

LastUpdatedRead Onlystringdate-time------
SubtotalRead Onlynumberfloat------

ShippingCostnumberfloat------

TaxCostnumberfloat------

PromotionDiscountRead Onlynumberfloat------

CurrencyRead Onlystring---------

TotalRead Onlynumberfloat------

IsSubmittedRead Onlyboolean---------

SubscriptionIDRead Onlystring---------

xpobject---------

Set a billing address.

PUT

/cart/billto

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 order's BillingAddressID property instead.

Roles

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

FullAccessShopper

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---
FromUserRead Onlyobject---------

FromCompanyIDstring---------

ToCompanyIDstring---------

FromUserIDstring---------

BillingAddressIDstring---------
BillingAddressRead Onlyobject---------
ShippingAddressIDstring---------

Commentsstring---2000 characters---
LineItemCountRead Onlyintegerint32------
StatusRead Onlystring------Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled
DateCreatedRead Onlystringdate-time------
DateSubmittedRead Onlystringdate-time------

DateApprovedRead Onlystringdate-time------
DateDeclinedRead Onlystringdate-time------
DateCanceledRead Onlystringdate-time------
DateCompletedRead Onlystringdate-time------

LastUpdatedRead Onlystringdate-time------
SubtotalRead Onlynumberfloat------

ShippingCostnumberfloat------

TaxCostnumberfloat------

PromotionDiscountRead Onlynumberfloat------

CurrencyRead Onlystring---------

TotalRead Onlynumberfloat------

IsSubmittedRead Onlyboolean---------

SubscriptionIDRead Onlystring---------

xpobject---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore