Sitecore OrderCloud Documentation

docs

Portal Login

Create a new line item.

POST

/orders/{direction}/{orderID}/lineitems

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.

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
IDstring---100 characters---
ProductIDRequiredstring---------
Quantityintegerint32------
UnitPricenumberfloat------

CostCenterstring---------

DateNeededstringdate-time------
ShippingAccountstring---------

ShippingAddressIDstring---------
ShipFromAddressIDstring---------

InventoryRecordIDstring---------

Specsarray---------
xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
ProductIDstring---------
Quantityintegerint32------
BundleItemIDRead Onlystring---------

IsBundleRead Onlyboolean---------

DateAddedRead Onlystringdate-time------
QuantityShippedRead Onlyintegerint32------

UnitPricenumberfloat------

PromotionDiscountRead Onlynumberfloat------

LineTotalRead Onlynumberfloat------

LineSubtotalRead Onlynumberfloat------

CostCenterstring---------

DateNeededstringdate-time------
ShippingAccountstring---------

ShippingAddressIDstring---------
ShipFromAddressIDstring---------

ProductRead Onlyobject---------
VariantRead Onlyobject---------
ShippingAddressRead Onlyobject---------
ShipFromAddressRead Onlyobject---------
SupplierIDRead Onlystring---------
InventoryRecordIDstring---------

PriceScheduleIDRead Onlystring---------

IsOnSaleRead Onlyboolean---------

PriceOverriddenRead Onlyboolean---------

Specsarray---------
IncomingOrderIDRead Onlystring---------

OutgoingOrderIDRead Onlystring---------

xpobject---------

Create a new line item.

POST

/orders/{direction}/{orderID}/lineitems

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.

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
IDstring---100 characters---
ProductIDRequiredstring---------
Quantityintegerint32------
UnitPricenumberfloat------

CostCenterstring---------

DateNeededstringdate-time------
ShippingAccountstring---------

ShippingAddressIDstring---------
ShipFromAddressIDstring---------

InventoryRecordIDstring---------

Specsarray---------
xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
ProductIDstring---------
Quantityintegerint32------
BundleItemIDRead Onlystring---------

IsBundleRead Onlyboolean---------

DateAddedRead Onlystringdate-time------
QuantityShippedRead Onlyintegerint32------

UnitPricenumberfloat------

PromotionDiscountRead Onlynumberfloat------

LineTotalRead Onlynumberfloat------

LineSubtotalRead Onlynumberfloat------

CostCenterstring---------

DateNeededstringdate-time------
ShippingAccountstring---------

ShippingAddressIDstring---------
ShipFromAddressIDstring---------

ProductRead Onlyobject---------
VariantRead Onlyobject---------
ShippingAddressRead Onlyobject---------
ShipFromAddressRead Onlyobject---------
SupplierIDRead Onlystring---------
InventoryRecordIDstring---------

PriceScheduleIDRead Onlystring---------

IsOnSaleRead Onlyboolean---------

PriceOverriddenRead Onlyboolean---------

Specsarray---------
IncomingOrderIDRead Onlystring---------

OutgoingOrderIDRead Onlystring---------

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

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

Contact Us
Privacy Policy
Sitecore