Sitecore OrderCloud Documentation

docs

Portal Login

Get a single order worksheet.

GET

/orders/{direction}/{orderID}/worksheet

200

Roles

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

FullAccessIntegrationEventAdminOrderAdminShopperOrderReader

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

Response Body

PropertyTypeFormatMax LengthPossible Values
Orderobject---------
LineItemsarray---------
OrderPromotionsarray---------
Subscriptionobject---------
ShipEstimateResponseobject---------
OrderCalculateResponseobject---------
OrderSubmitResponseobject---------
OrderSubmitForApprovalResponseobject---------
OrderApprovedResponseobject---------
SubscriptionIntegrationResponseobject---------

Get a single order worksheet.

GET

/orders/{direction}/{orderID}/worksheet

200

Roles

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

FullAccessIntegrationEventAdminOrderAdminShopperOrderReader

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

Response Body

PropertyTypeFormatMax LengthPossible Values
Orderobject---------
LineItemsarray---------
OrderPromotionsarray---------
Subscriptionobject---------
ShipEstimateResponseobject---------
OrderCalculateResponseobject---------
OrderSubmitResponseobject---------
OrderSubmitForApprovalResponseobject---------
OrderApprovedResponseobject---------
SubscriptionIntegrationResponseobject---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore