buyerID

search

Comma-delimited list of fields to search on.

searchOn

Comma-delimited list of fields to sort by.

sortBy

Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

page

Number of results to return per page. Default: 20, max: 100.

pageSize

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

filters

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

addressID

userID

userGroupID

Level of the address assignment. Possible values: User, Group, Company.

level

isShipping

isBilling

If an object with the same ID already exists, it will be overwritten.

Get a list of admin user group user assignments.

Create or update an admin user group user assignment.

Delete an admin user group user assignment.

apiClientID

supplierID

Create or update a API client assignment.

approvalRuleID

Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.

direction

orderID

bundleID

bundleItemID

subscriptionID

catalogID

categoryID

Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.

searchType

Level of the bundle assignment. Possible values: User, Group, Company.

productID

Get a list of bundle product assignments.

Create or update a bundle product assignment.

sellerID

If the ID of the Order returned is null, the cart has not yet been interacted with. Once an item is added, the Order.ID will be populated.

If an object with the same ID already exists, it will be overwritten. The recommended way to initiate a new cart is to add a line item. If there is a specific reason an order needs to exist prior to adding a line item, this method can be used to initiate a new cart.

If an object with the same ID already exists, it will be overwritten..The recommended way to initiate a new cart is to add a line item. If there is a specific reason an order needs to exist prior to adding a line item, this method can be used to initiate a new cart.

Empties the cart. Any promotions, payments or other items associated with the cart will also be removed.

Apply up to 100 eligible promotions to the cart.

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.

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.

Not allowed on carts where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address.

Get a list of promotions eligible for the cart.

Only FirstName, LastName, and Email can be updated. Primarily used to facilitate guest checkout scenarios.

Only FirstName, LastName, and Email can be updated..Primarily used to facilitate guest checkout scenarios.

lineItemID

paymentID

transactionID

promoCode

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 ShippingAddressID property instead. The address used will be populated on the ShippingAddress property of each LineItem.

Not allowed on carts where ShippingAddressID has been set. In that case, use the Addresses resource to update the saved address.

Partially update a cart shipping address.

Get a list of catalog bundle assignments.

Create or update a catalog bundle assignment.

Get a list of catalog product assignments.

Create or update a catalog product assignment.

Returns a JSON Web Key (JWK). Can be used for validating the token was signed by OrderCloud.

costCenterID

Level of the cost center assignment. Possible values: User, Group, Company.

Create or update a cost center assignment.

creditCardID

Level of the credit card assignment. Possible values: User, Group, Company.

Create or update a credit card assignment.

deliveryConfigID

Create or update a delivery configuration.

Partially update a delivery configuration.

Get the entity sync delivery configuration for AdminUsers

Create or update the entity sync delivery configuration for AdminUsers

Delete the entity sync delivery configuration for AdminUsers

Get the entity sync delivery configuration for BuyerUsers

Create or update the entity sync delivery configuration for BuyerUsers

Delete the entity sync delivery configuration for BuyerUsers

Get the entity sync delivery configuration for Categories

Create or update the entity sync delivery configuration for Categories

Delete the entity sync delivery configuration for Categories

Get the entity sync delivery configuration for Suppliers

Create or update the entity sync delivery configuration for Suppliers

Delete the entity sync delivery configuration for Suppliers

Get the entity sync delivery configuration for SupplierUsers

Create or update the entity sync delivery configuration for SupplierUsers

Delete the entity sync delivery configuration for SupplierUsers

Sends a temporary verification code via email, which must subsequently be passed in a Reset Password call. The verification code expires in 120 minutes.

verificationCode

Sends an email with username for every username associated with an email. Always returns a 200 success regardless of if email doesn’t exist in the clientID.

clientID

email

impersonationConfigID

Create or update an impersonation config.

Partially update an impersonation config.

incrementorID

integrationEventID

inventoryRecordID

Level of the inventory record assignment. Possible values: User, Group, Company.

Get a list of inventory record assignments.

Create or update an inventory record assignment.

variantID

Get a list of inventory record variant assignments.

Create or update an inventory record variant assignment.

Create or update a variant inventory record.

Partially update a variant inventory record.

Delete an inventory record variant assignment.

Lower bound of date range that the order was created.

from

Upper bound of date range that the order was created.

Set the Shipping Address of the Line Item. Appropriate only when the Address is not to be saved/reused. To use a Saved Address (i.e. from the Addresses resource), PATCH the Line Item's ShippingAddressID property instead.

Partially update the Shipping Address of the Line Item. Not allowed on unsubmitted Line Items where ShippingAddressID has been set. In that case, use the Addresses resource to update the Saved Address.

Partially update a line item shipping address.

anonUserToken

Get a list of message sender cc listener assignments.

Create or update a message sender cc listener assignment.

messageSenderID

Level of the message sender assignment. Possible values: User, Group, Company.

Get a list of message sender assignments.

Create or update a message sender assignment.

Get a list of addresses visible to this user.

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

Get a list of catalogs visible to this user.

Indicates how deep down the hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to ParentID if specified. Default is 1.

depth

The user’s default CatalogID will be used to return categories if you do not pass another CatalogID explicitly. Listing categories across multiple catalogs is not supported.

Get a list of categories visible to this user.

Get a list of cost centers visible to this user.

Get a list of credit cards visible to this user.

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

creditcardID

Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).

Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).

Get a list of orders visible to this user.

If a user begins an order as the anonymous shopper and later logs in, use this endpoint to transfer that order to them.

Get a list of orders that this user can approve.

Get a list of product collections visible to this user.

productCollectionID

Get a list of product collection invitations visible to this user.

Create a new product collection invitation.

invitationID

Get a single product collection invitation.

Partially update a product collection invitation.

Get a list of product collection entries visible to this user.

Indicates how deep down the category hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to CategoryID if specified, otherwise top level of the Catalog. Default is 'all'.

Get a list of products visible to this user.

Get a list of product inventory records visible to this user.

Get a list of product sellers visible to this user.

Get a list of specs visible to this user.

specID

Get a list of variants visible to this user.

Get a list of variant inventory records visible to this user.

Get a list of promotions visible to this user.

promotionID

Organizations you can place orders directly to.

Get a list of sellers this user can purchase from.

Get a list of shipments visible to this user.

shipmentID

Get a list of shipment items visible to this user.

Get a list of spending accounts visible to this user.

spendingAccountID

Get a list of subscription items visible to this user.

subscriptionItemID

Get a list of subscriptions visible to this user.

Get a list of user groups visible to this user.

openidconnectID

Only returns orders awaiting the user's approval if true.

approvable

returnID

Returns all Approvals associated with the Order Return.

Use only when an order return won't have an associated payment. You will not to reopen an order return after completing it.

Returns all Users who can approve or decline this order return (but have not done so).

Get a list of order return eligible approvers.

Apply up to 100 eligible promotions to an order.

Returns all Approvals associated with the Order.

Not allowed on unsubmitted orders where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address.

Partially update an order billing address.

Use only when an order doesn't need a shipment. You will not be able to ship or reopen an order after completing it.

Returns all Users who can approve or decline this order (but have not done so).

Get a list of promotions eligible for an order.

Creates and submits 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order.

Create a new shipment containing all items on an order.

Not allowed on unsubmitted orders where ShippingAddressID has been set. In that case, use the Addresses resource to update the saved address.

Partially update an order shipping address.

Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order.

PUT is not a supported method for payments due to the implications associated with modifying certain properties. Patch is only permitted on certain properties that vary depending on order status

priceScheduleID

Create or update a price schedule price break.

quantity

Get a list of product collection entries.

productFacetID

Level of the product assignment. Possible values: User, Group, Company.

defaultPriceScheduleID

overwriteExisting

Level of the promotion assignment. Possible values: User, Group, Company.

securityProfileID

Commerce role of the security profile assignment. Possible values: Buyer, Seller, Supplier.

commerceRole

Get a list of security profile assignments.

Price Schedules