Sitecore OrderCloud Documentation

docs

Portal Login

Approve an order.

POST

/orders/{direction}/{orderID}/approve

Roles

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

FullAccessOrderAdminShopper

Parameters

NameTypeDescriptionPossible Values
directionRequiredstringDirection of the order, from the current user's perspective. Possible values: incoming, outgoing, all.Incoming, Outgoing, All
orderIDRequiredstringID of the order.---

Request Body

PropertyTypeFormatMax LengthPossible Values
AllowResubmitboolean---------

Commentsstring---2000 characters---

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

Approve an order.

POST

/orders/{direction}/{orderID}/approve

Roles

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

FullAccessOrderAdminShopper

Parameters

NameTypeDescriptionPossible Values
directionRequiredstringDirection of the order, from the current user's perspective. Possible values: incoming, outgoing, all.Incoming, Outgoing, All
orderIDRequiredstringID of the order.---

Request Body

PropertyTypeFormatMax LengthPossible Values
AllowResubmitboolean---------

Commentsstring---2000 characters---

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 2023, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore